Make widget refreshing configurable

w2sv · w2sv · commit 7ab73fb50606 · 2023-03-22T12:16:24.000+01:00
diff --git a/app/src/main/kotlin/com/w2sv/wifiwidget/activities/HomeActivity.kt b/app/src/main/kotlin/com/w2sv/wifiwidget/activities/HomeActivity.kt
@@ -22,6 +22,7 @@ import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
 import androidx.core.splashscreen.SplashScreenViewProvider
 import androidx.lifecycle.LifecycleObserver
 import androidx.lifecycle.SavedStateHandle
+import androidx.lifecycle.lifecycleScope
 import androidx.lifecycle.viewModelScope
 import androidx.localbroadcastmanager.content.LocalBroadcastManager
 import com.w2sv.androidutils.SelfManagingLocalBroadcastReceiver
@@ -31,10 +32,12 @@ import com.w2sv.androidutils.extensions.locationServicesEnabled
 import com.w2sv.androidutils.extensions.showToast
 import com.w2sv.common.Theme
 import com.w2sv.kotlinutils.extensions.getByOrdinal
+import com.w2sv.preferences.EnumOrdinals
 import com.w2sv.preferences.FloatPreferences
 import com.w2sv.preferences.GlobalFlags
-import com.w2sv.preferences.EnumOrdinals
 import com.w2sv.preferences.WidgetProperties
+import com.w2sv.preferences.WidgetRefreshingParameters
+import com.w2sv.widget.WidgetDataRefreshWorker
 import com.w2sv.widget.WifiWidgetProvider
 import com.w2sv.wifiwidget.R
 import com.w2sv.wifiwidget.ui.home.HomeScreen
@@ -47,6 +50,7 @@ import dagger.hilt.android.AndroidEntryPoint
 import dagger.hilt.android.lifecycle.HiltViewModel
 import dagger.hilt.android.qualifiers.ApplicationContext
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.launch
 import slimber.log.i
 import javax.inject.Inject
 
@@ -59,6 +63,7 @@ class HomeActivity : LifecycleObserversRegisteringActivity() {
         private val globalFlags: GlobalFlags,
         private val enumOrdinals: EnumOrdinals,
         private val floatPreferences: FloatPreferences,
+        private val widgetRefreshingParameters: WidgetRefreshingParameters,
         savedStateHandle: SavedStateHandle,
         @ApplicationContext context: Context
     ) : androidx.lifecycle.ViewModel() {
@@ -68,7 +73,8 @@ class HomeActivity : LifecycleObserversRegisteringActivity() {
                 widgetProperties,
                 globalFlags,
                 enumOrdinals,
-                floatPreferences
+                floatPreferences,
+                widgetRefreshingParameters
             )
 
         /**
@@ -146,10 +152,21 @@ class HomeActivity : LifecycleObserversRegisteringActivity() {
             { floatPreferences.opacity = it }
         )
 
+        val widgetRefreshingParametersState = NonAppliedSnapshotStateMap(
+            { widgetRefreshingParameters },
+            {
+                widgetRefreshingParameters.putAll(it)
+                widgetRefreshingParametersChanged.value = true
+            }
+        )
+
+        val widgetRefreshingParametersChanged = MutableStateFlow(false)
+
         val widgetConfigurationStates = CoherentNonAppliedStates(
             widgetPropertyStateMap,
             widgetThemeState,
             widgetOpacityState,
+            widgetRefreshingParametersState,
             coroutineScope = viewModelScope
         )
 
@@ -230,6 +247,18 @@ class HomeActivity : LifecycleObserversRegisteringActivity() {
 
         super.onCreate(savedInstanceState)
 
+        lifecycleScope.launch {
+            with(viewModel.widgetRefreshingParametersChanged) {
+                collect {
+                    if (it) {
+                        WidgetDataRefreshWorker.Administrator.getInstance(applicationContext)
+                            .applyChangedParameters()
+                    }
+                    value = false
+                }
+            }
+        }
+
         setContent {
             val theme by viewModel.appliedInAppTheme.collectAsState()
 
diff --git a/app/src/main/kotlin/com/w2sv/wifiwidget/ui/home/configurationdialog/ContentColumn.kt b/app/src/main/kotlin/com/w2sv/wifiwidget/ui/home/configurationdialog/ContentColumn.kt
@@ -13,6 +13,7 @@ import androidx.compose.foundation.verticalScroll
 import androidx.compose.material3.Icon
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.painterResource
@@ -26,6 +27,7 @@ import com.w2sv.wifiwidget.R
 import com.w2sv.wifiwidget.ui.shared.JostText
 import com.w2sv.wifiwidget.ui.shared.ThemeSelectionRow
 import com.w2sv.wifiwidget.ui.shared.WifiWidgetTheme
+import kotlinx.coroutines.launch
 
 @Preview
 @Composable
@@ -54,12 +56,18 @@ internal fun ContentColumn(
     onCheckedChange: (String, Boolean) -> Unit,
     onInfoButtonClick: (Int) -> Unit
 ) {
+    val scrollState = rememberScrollState()
+    val scope = rememberCoroutineScope()
+
     Column(
         horizontalAlignment = Alignment.CenterHorizontally,
         modifier = modifier
             .padding(vertical = 16.dp)
-            .verticalScroll(rememberScrollState())
+            .verticalScroll(scrollState)
     ) {
+        val checkablePropertiesColumnModifier = Modifier.padding(horizontal = 26.dp)
+        val defaultSectionHeaderModifier = Modifier.padding(vertical = 22.dp)
+
         SectionHeader(
             R.string.theme,
             R.drawable.ic_nightlight_24,
@@ -74,20 +82,34 @@ internal fun ContentColumn(
         SectionHeader(
             R.string.opacity,
             R.drawable.ic_opacity_24,
-            Modifier.padding(vertical = 22.dp)
+            defaultSectionHeaderModifier
         )
         OpacitySliderWithValue(opacity = opacity, onOpacityChanged = onOpacityChanged)
 
         SectionHeader(
             R.string.properties,
             R.drawable.ic_checklist_24,
-            Modifier.padding(vertical = 22.dp)
+            defaultSectionHeaderModifier
         )
         PropertyColumn(
+            modifier = checkablePropertiesColumnModifier,
             propertyChecked = propertyChecked,
             onCheckedChange = onCheckedChange,
             onInfoButtonClick = onInfoButtonClick
         )
+
+        SectionHeader(
+            titleRes = R.string.refreshing,
+            iconRes = com.w2sv.widget.R.drawable.ic_refresh_24,
+            modifier = defaultSectionHeaderModifier
+        )
+        RefreshingSection(checkablePropertiesColumnModifier) {
+            scope.launch {
+                with(scrollState) {
+                    animateScrollTo(maxValue)
+                }
+            }
+        }
     }
 }
 
diff --git a/app/src/main/kotlin/com/w2sv/wifiwidget/ui/home/configurationdialog/PropertyColumn.kt b/app/src/main/kotlin/com/w2sv/wifiwidget/ui/home/configurationdialog/PropertyColumn.kt
@@ -2,7 +2,6 @@ package com.w2sv.wifiwidget.ui.home.configurationdialog
 
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.Row
-import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.layout.size
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.outlined.Info
@@ -16,20 +15,18 @@ import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.dimensionResource
 import androidx.compose.ui.res.stringArrayResource
-import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import com.w2sv.wifiwidget.R
 import com.w2sv.wifiwidget.ui.shared.JostText
 
 @Composable
 internal fun PropertyColumn(
+    modifier: Modifier = Modifier,
     propertyChecked: (String) -> Boolean,
     onCheckedChange: (String, Boolean) -> Unit,
     onInfoButtonClick: (Int) -> Unit
 ) {
-    Column(
-        modifier = Modifier.padding(horizontal = 26.dp)
-    ) {
+    Column(modifier = modifier) {
         stringArrayResource(id = R.array.wifi_properties)
             .forEachIndexed { propertyIndex, property ->
                 PropertyRow(
diff --git a/app/src/main/kotlin/com/w2sv/wifiwidget/ui/home/configurationdialog/RefreshingSection.kt b/app/src/main/kotlin/com/w2sv/wifiwidget/ui/home/configurationdialog/RefreshingSection.kt
@@ -0,0 +1,74 @@
+package com.w2sv.wifiwidget.ui.home.configurationdialog
+
+import androidx.annotation.StringRes
+import androidx.compose.animation.AnimatedVisibility
+import androidx.compose.animation.expandVertically
+import androidx.compose.animation.fadeIn
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material3.Checkbox
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.unit.TextUnit
+import androidx.compose.ui.unit.dp
+import androidx.compose.ui.unit.sp
+import com.w2sv.wifiwidget.R
+import com.w2sv.wifiwidget.activities.HomeActivity
+import com.w2sv.wifiwidget.ui.shared.JostText
+
+@Composable
+internal fun RefreshingSection(
+    modifier: Modifier = Modifier,
+    viewModel: HomeActivity.ViewModel = androidx.lifecycle.viewmodel.compose.viewModel(),
+    scrollToContentColumnBottom: () -> Unit
+) {
+    Column(modifier = modifier, horizontalAlignment = Alignment.Start) {
+        RefreshingParameterRow(
+            label = R.string.refresh_periodically,
+            parameterName = "refreshPeriodically",
+            viewModel = viewModel
+        )
+        AnimatedVisibility(
+            visible = viewModel.widgetRefreshingParametersState.getValue("refreshPeriodically"),
+            enter = fadeIn() + expandVertically(initialHeight = { scrollToContentColumnBottom(); 0 })
+        ) {
+            RefreshingParameterRow(
+                label = R.string.refresh_on_low_battery,
+                parameterName = "refreshOnBatteryLow",
+                viewModel = viewModel,
+                modifier = Modifier.padding(start = 12.dp),
+                fontSize = 14.sp
+            )
+        }
+    }
+}
+
+@Composable
+private fun RefreshingParameterRow(
+    @StringRes label: Int,
+    parameterName: String,
+    viewModel: HomeActivity.ViewModel,
+    modifier: Modifier = Modifier,
+    fontSize: TextUnit = TextUnit.Unspecified
+) {
+    Row(
+        verticalAlignment = Alignment.CenterVertically,
+        horizontalArrangement = Arrangement.SpaceBetween,
+        modifier = Modifier
+            .fillMaxWidth()
+            .then(modifier)
+    ) {
+        JostText(text = stringResource(id = label), fontSize = fontSize)
+        Checkbox(
+            checked = viewModel.widgetRefreshingParametersState.map.getValue(parameterName),
+            onCheckedChange = {
+                viewModel.widgetRefreshingParametersState[parameterName] = it
+            }
+        )
+    }
+}
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -21,4 +21,7 @@
     <string name="theme">Theme</string>
     <string name="properties">Properties</string>
     <string name="opacity">Opacity</string>
+    <string name="refreshing">Refreshing</string>
+    <string name="refresh_periodically">Refresh periodically</string>
+    <string name="refresh_on_low_battery">Refresh on low battery</string>
 </resources>
diff --git a/preferences/src/main/kotlin/com/w2sv/preferences/WidgetRefreshingParameters.kt b/preferences/src/main/kotlin/com/w2sv/preferences/WidgetRefreshingParameters.kt
@@ -0,0 +1,16 @@
+package com.w2sv.preferences
+
+import android.content.SharedPreferences
+import com.w2sv.typedpreferences.BooleanPreferences
+import javax.inject.Inject
+import javax.inject.Singleton
+
+@Singleton
+class WidgetRefreshingParameters @Inject constructor(sharedPreferences: SharedPreferences): BooleanPreferences(
+    "refreshPeriodically" to true,
+    "refreshOnBatteryLow" to false,
+    sharedPreferences = sharedPreferences
+){
+    val refreshPeriodically by this
+    val refreshOnBatteryLow by this
+}
diff --git a/widget/src/main/kotlin/com/w2sv/widget/WidgetDataRefreshWorker.kt b/widget/src/main/kotlin/com/w2sv/widget/WidgetDataRefreshWorker.kt
@@ -8,23 +8,30 @@ import androidx.work.PeriodicWorkRequestBuilder
 import androidx.work.WorkManager
 import androidx.work.Worker
 import androidx.work.WorkerParameters
+import com.w2sv.preferences.WidgetRefreshingParameters
+import dagger.hilt.EntryPoint
+import dagger.hilt.InstallIn
+import dagger.hilt.android.EntryPointAccessors
+import dagger.hilt.android.qualifiers.ApplicationContext
+import dagger.hilt.components.SingletonComponent
 import slimber.log.i
 import java.time.Duration
+import javax.inject.Inject
 
-internal class WidgetDataRefreshWorker(context: Context, workerParams: WorkerParameters) :
+class WidgetDataRefreshWorker(context: Context, workerParams: WorkerParameters) :
     Worker(context, workerParams) {
 
     companion object {
-        const val UNIQUE_WORK_NAME = "WidgetDataRefreshWorker"
+        private const val UNIQUE_WORK_NAME = "WidgetDataRefreshWorker"
 
-        fun enqueueAsUniquePeriodicWork(
+        private fun enqueueAsUniquePeriodicWork(
             workManager: WorkManager,
             refreshPeriod: Duration,
             requiresBatteryNotLow: Boolean
         ) {
             workManager.enqueueUniquePeriodicWork(
                 UNIQUE_WORK_NAME,
-                ExistingPeriodicWorkPolicy.KEEP,
+                ExistingPeriodicWorkPolicy.UPDATE,
                 PeriodicWorkRequestBuilder<WidgetDataRefreshWorker>(refreshPeriod)
                     .setConstraints(
                         Constraints.Builder()
@@ -34,6 +41,56 @@ internal class WidgetDataRefreshWorker(context: Context, workerParams: WorkerPar
                     .setInitialDelay(refreshPeriod)
                     .build()
             )
+            i { "Enqueued $UNIQUE_WORK_NAME" }
+        }
+    }
+
+    class Administrator @Inject constructor(
+        @ApplicationContext private val context: Context,
+        private val widgetRefreshingParameters: WidgetRefreshingParameters
+    ) {
+
+        @InstallIn(SingletonComponent::class)
+        @EntryPoint
+        interface EntryPointInterface {
+            fun getAdministratorInstance(): Administrator
+        }
+
+        companion object {
+            fun getInstance(context: Context): Administrator =
+                EntryPointAccessors.fromApplication(
+                    context,
+                    EntryPointInterface::class.java
+                )
+                    .getAdministratorInstance()
+        }
+
+        fun applyChangedParameters(){
+            when(widgetRefreshingParameters.refreshPeriodically){
+                true -> enableWorker()
+                false -> cancelWorker()
+            }
+        }
+
+        fun enableWorkerIfApplicable() {
+            if (widgetRefreshingParameters.refreshPeriodically) {
+                enableWorker()
+            }
+        }
+
+        private fun enableWorker(){
+            enqueueAsUniquePeriodicWork(
+                WorkManager.getInstance(context),
+                Duration.ofMinutes(15L),
+                !widgetRefreshingParameters.refreshOnBatteryLow
+            )
+        }
+
+        fun cancelWorker() {
+            WorkManager.getInstance(context)
+                .cancelUniqueWork(UNIQUE_WORK_NAME)
+
+            i { "Cancelled $UNIQUE_WORK_NAME" }
         }
     }
 
diff --git a/widget/src/main/kotlin/com/w2sv/widget/WifiWidgetProvider.kt b/widget/src/main/kotlin/com/w2sv/widget/WifiWidgetProvider.kt
