Skip to content
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

Rewrite BatteryOptimizationsPage to M3 #747

Merged
merged 20 commits into from
May 15, 2024
Merged

Rewrite BatteryOptimizationsPage to M3 #747

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
795c9b2
Migrated to M3
ArnyminerZ Apr 24, 2024
3e8a758
Arch update for best practises
ArnyminerZ Apr 24, 2024
a1a60ce
Moved composable to individual file
ArnyminerZ Apr 24, 2024
9bcf57a
Renamed function
ArnyminerZ Apr 28, 2024
dd27e76
Merge branch 'main-ose' into 741-rewrite-batteryoptimizationspage-to-m3
ArnyminerZ Apr 28, 2024
0ea9ed6
Merge branch 'main-ose' into 741-rewrite-batteryoptimizationspage-to-m3
sunkup Apr 30, 2024
be28d35
Moved ViewModel
ArnyminerZ Apr 30, 2024
64959f3
Moved ViewModel
ArnyminerZ Apr 30, 2024
3b6be53
Moved ViewModel-based Composable
ArnyminerZ Apr 30, 2024
257f899
Created `UiState`
ArnyminerZ Apr 30, 2024
2b58ae4
Fixed model name
ArnyminerZ Apr 30, 2024
89adf88
Typo
ArnyminerZ Apr 30, 2024
d07d109
Merge branch 'main-ose' into 741-rewrite-batteryoptimizationspage-to-m3
ArnyminerZ Apr 30, 2024
0d62c87
Merge branch 'main-ose' into 741-rewrite-batteryoptimizationspage-to-m3
ArnyminerZ May 3, 2024
eb408ee
Fixed checkboxes
ArnyminerZ May 3, 2024
19a077d
Make checkboxes clickable too
sunkup May 6, 2024
2ae9df7
Merge branch 'main-ose' into 741-rewrite-batteryoptimizationspage-to-m3
ArnyminerZ May 8, 2024
45e3689
Optimized imports
ArnyminerZ May 8, 2024
30d03bd
Merge branch 'main-ose' into 741-rewrite-batteryoptimizationspage-to-m3
sunkup May 13, 2024
946a384
Optimize imports
sunkup May 13, 2024
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
5 changes: 3 additions & 2 deletions app/src/main/kotlin/at/bitfire/davdroid/ui/AppSettingsActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ import at.bitfire.davdroid.ui.composable.Setting
import at.bitfire.davdroid.ui.composable.SettingsHeader
import at.bitfire.davdroid.ui.composable.SwitchSetting
import at.bitfire.davdroid.ui.intro.BatteryOptimizationsPage
import at.bitfire.davdroid.ui.intro.BatteryOptimizationsPageModel
import at.bitfire.davdroid.ui.intro.OpenSourcePage
import at.bitfire.davdroid.util.PermissionUtils
import at.bitfire.davdroid.util.TaskUtils
Expand Down Expand Up @@ -539,8 +540,8 @@ class AppSettingsActivity: AppCompatActivity() {
}

fun resetHints() {
settings.remove(BatteryOptimizationsPage.Model.HINT_BATTERY_OPTIMIZATIONS)
settings.remove(BatteryOptimizationsPage.Model.HINT_AUTOSTART_PERMISSION)
settings.remove(BatteryOptimizationsPageModel.HINT_BATTERY_OPTIMIZATIONS)
settings.remove(BatteryOptimizationsPageModel.HINT_AUTOSTART_PERMISSION)
settings.remove(TasksActivity.Model.HINT_OPENTASKS_NOT_INSTALLED)
settings.remove(OpenSourcePage.Model.SETTING_NEXT_DONATION_POPUP)
}
Expand Down
328 changes: 5 additions & 323 deletions app/src/main/kotlin/at/bitfire/davdroid/ui/intro/BatteryOptimizationsPage.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,64 +8,16 @@ import android.annotation.SuppressLint
import android.app.Application
import android.content.Context
import android.content.Intent
import android.content.IntentFilter
import android.net.Uri
import android.os.Build
import android.os.PowerManager
import androidx.activity.compose.rememberLauncherForActivityResult
import androidx.activity.result.contract.ActivityResultContract
import androidx.compose.animation.AnimatedVisibility
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.rememberScrollState
import androidx.compose.foundation.verticalScroll
import androidx.compose.material.Card
import androidx.compose.material.Checkbox
import androidx.compose.material.MaterialTheme
import androidx.compose.material.OutlinedButton
import androidx.compose.material.Switch
import androidx.compose.material.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.getValue
import androidx.compose.runtime.livedata.observeAsState
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalUriHandler
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import androidx.core.content.getSystemService
import androidx.lifecycle.MutableLiveData
import androidx.lifecycle.ViewModel
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.compose.viewModel
import at.bitfire.davdroid.BuildConfig
import at.bitfire.davdroid.Constants
import at.bitfire.davdroid.Constants.withStatParams
import at.bitfire.davdroid.R
import at.bitfire.davdroid.settings.SettingsManager
import at.bitfire.davdroid.ui.M2Theme
import at.bitfire.davdroid.ui.intro.BatteryOptimizationsPage.Model.Companion.HINT_AUTOSTART_PERMISSION
import at.bitfire.davdroid.ui.intro.BatteryOptimizationsPage.Model.Companion.HINT_BATTERY_OPTIMIZATIONS
import at.bitfire.davdroid.util.PermissionUtils
import at.bitfire.davdroid.util.broadcastReceiverFlow
import at.bitfire.davdroid.ui.intro.BatteryOptimizationsPageModel.Companion.HINT_AUTOSTART_PERMISSION
import at.bitfire.davdroid.ui.intro.BatteryOptimizationsPageModel.Companion.HINT_BATTERY_OPTIMIZATIONS
import dagger.hilt.EntryPoint
import dagger.hilt.InstallIn
import dagger.hilt.android.EntryPointAccessors
import dagger.hilt.android.lifecycle.HiltViewModel
import dagger.hilt.components.SingletonComponent
import kotlinx.coroutines.launch
import org.apache.commons.text.WordUtils
import java.util.Locale
import javax.inject.Inject

class BatteryOptimizationsPage: IntroPage {

Expand All @@ -83,8 +35,8 @@ class BatteryOptimizationsPage: IntroPage {
// 2a. evil manufacturer AND
// 2b. "don't show anymore" has not been clicked
return if (
(!Model.isExempted(application) && settingsManager.getBooleanOrNull(HINT_BATTERY_OPTIMIZATIONS) != false) ||
(Model.manufacturerWarning && settingsManager.getBooleanOrNull(HINT_AUTOSTART_PERMISSION) != false)
(!BatteryOptimizationsPageModel.isExempted(application) && settingsManager.getBooleanOrNull(HINT_BATTERY_OPTIMIZATIONS) != false) ||
(BatteryOptimizationsPageModel.manufacturerWarning && settingsManager.getBooleanOrNull(HINT_AUTOSTART_PERMISSION) != false)
)
IntroPage.ShowPolicy.SHOW_ALWAYS
else
Expand All @@ -93,115 +45,7 @@ class BatteryOptimizationsPage: IntroPage {

@Composable
override fun ComposePage() {
IntroPage_FromModel()
}

@Composable
private fun IntroPage_FromModel(
model: Model = viewModel()
) {
val ignoreBatteryOptimizationsResultLauncher = rememberLauncherForActivityResult(IgnoreBatteryOptimizationsContract) {
model.checkBatteryOptimizations()
}

val hintBatteryOptimizations by model.hintBatteryOptimizations.collectAsStateWithLifecycle(false)
val shouldBeExempted by model.shouldBeExempted.observeAsState(false)
val isExempted by model.isExempted.observeAsState(false)
LaunchedEffect(shouldBeExempted, isExempted) {
if (shouldBeExempted && !isExempted)
ignoreBatteryOptimizationsResultLauncher.launch(BuildConfig.APPLICATION_ID)
}

val hintAutostartPermission by model.hintAutostartPermission.collectAsStateWithLifecycle(false)
BatteryOptimizationsContent(
dontShowBattery = hintBatteryOptimizations == false,
onChangeDontShowBattery = {
model.settings.putBoolean(HINT_BATTERY_OPTIMIZATIONS, !it)
},
isExempted = isExempted,
shouldBeExempted = shouldBeExempted,
onChangeShouldBeExempted = model.shouldBeExempted::postValue,
dontShowAutostart = hintAutostartPermission == false,
onChangeDontShowAutostart = {
model.settings.putBoolean(HINT_AUTOSTART_PERMISSION, !it)
},
manufacturerWarning = Model.manufacturerWarning
)
}


@HiltViewModel
class Model @Inject constructor(
val context: Application,
val settings: SettingsManager
): ViewModel() {

companion object {

/**
* Whether the request for whitelisting from battery optimizations shall be shown.
* If this setting is true or null/not set, the notice shall be shown. Only if this
* setting is false, the notice shall not be shown.
*/
const val HINT_BATTERY_OPTIMIZATIONS = "hint_BatteryOptimizations"

/**
* Whether the autostart permission notice shall be shown. If this setting is true
* or null/not set, the notice shall be shown. Only if this setting is false, the notice
* shall not be shown.
*
* Type: Boolean
*/
const val HINT_AUTOSTART_PERMISSION = "hint_AutostartPermissions"

/**
* List of manufacturers which are known to restrict background processes or otherwise
* block synchronization.
*
* See https://www.davx5.com/faq/synchronization-is-not-run-as-expected for why this is evil.
* See https://github.com/jaredrummler/AndroidDeviceNames/blob/master/json/ for manufacturer values.
*/
private val evilManufacturers = arrayOf("asus", "huawei", "lenovo", "letv", "meizu", "nokia",
"oneplus", "oppo", "samsung", "sony", "vivo", "wiko", "xiaomi", "zte")

/**
* Whether the device has been produced by an evil manufacturer.
*
* Always true for debug builds (to test the UI).
*
* @see evilManufacturers
*/
val manufacturerWarning =
(evilManufacturers.contains(Build.MANUFACTURER.lowercase(Locale.ROOT)) || BuildConfig.DEBUG)

fun isExempted(context: Context) =
context.getSystemService<PowerManager>()!!.isIgnoringBatteryOptimizations(BuildConfig.APPLICATION_ID)
}

val shouldBeExempted = MutableLiveData<Boolean>()
val isExempted = MutableLiveData<Boolean>()
val hintBatteryOptimizations = settings.getBooleanFlow(HINT_BATTERY_OPTIMIZATIONS)

val hintAutostartPermission = settings.getBooleanFlow(HINT_AUTOSTART_PERMISSION)

init {
viewModelScope.launch {
broadcastReceiverFlow(context, IntentFilter(PermissionUtils.ACTION_POWER_SAVE_WHITELIST_CHANGED), immediate = true).collect {
checkBatteryOptimizations()
}
}
}

fun checkBatteryOptimizations() {
val exempted = isExempted(context)
isExempted.value = exempted
shouldBeExempted.value = exempted

// if DAVx5 is whitelisted, always show a reminder as soon as it's not whitelisted anymore
if (exempted)
settings.remove(HINT_BATTERY_OPTIMIZATIONS)
}

BatteryOptimizationsPageContent()
}


Expand All @@ -220,165 +64,3 @@ class BatteryOptimizationsPage: IntroPage {
}

}

@Preview(showBackground = true, showSystemUi = true)
@Composable
private fun BatteryOptimizationsContent_Preview() {
M2Theme {
BatteryOptimizationsContent(
dontShowBattery = true,
onChangeDontShowBattery = {},
isExempted = false,
shouldBeExempted = true,
onChangeShouldBeExempted = {},
dontShowAutostart = false,
onChangeDontShowAutostart = {},
manufacturerWarning = true
)
}
}

@Composable
private fun BatteryOptimizationsContent(
dontShowBattery: Boolean,
onChangeDontShowBattery: (Boolean) -> Unit,
isExempted: Boolean,
shouldBeExempted: Boolean,
onChangeShouldBeExempted: (Boolean) -> Unit,
dontShowAutostart: Boolean,
onChangeDontShowAutostart: (Boolean) -> Unit,
manufacturerWarning: Boolean
) {
val uriHandler = LocalUriHandler.current

Column(
modifier = Modifier
.fillMaxSize()
.verticalScroll(rememberScrollState())
) {
Card(
modifier = Modifier.padding(8.dp)
) {
Column(
modifier = Modifier
.fillMaxWidth()
.padding(16.dp)
) {
Row(
modifier = Modifier.fillMaxWidth(),
verticalAlignment = Alignment.CenterVertically
) {
Text(
text = stringResource(R.string.intro_battery_title),
style = MaterialTheme.typography.h6,
modifier = Modifier.weight(1f)
)
Switch(
checked = shouldBeExempted,
onCheckedChange = {
// Only accept click events if not whitelisted
if (!isExempted) {
onChangeShouldBeExempted(it)
}
},
enabled = !dontShowBattery
)
}
Text(
text = stringResource(
R.string.intro_battery_text,
stringResource(R.string.app_name)
),
style = MaterialTheme.typography.body1,
modifier = Modifier.padding(top = 12.dp)
)
AnimatedVisibility(visible = !isExempted) {
Row(
verticalAlignment = Alignment.CenterVertically
) {
Checkbox(
checked = dontShowBattery,
onCheckedChange = onChangeDontShowBattery,
enabled = !isExempted
)
Text(
text = stringResource(R.string.intro_battery_dont_show),
style = MaterialTheme.typography.body2,
modifier = Modifier
.clickable { onChangeDontShowBattery(!dontShowBattery) }
)
}
}
}
}
if (manufacturerWarning) {
Card(
modifier = Modifier
.padding(8.dp)
) {
Column(
modifier = Modifier
.fillMaxWidth()
.padding(16.dp)
) {
Text(
text = stringResource(
R.string.intro_autostart_title,
WordUtils.capitalize(Build.MANUFACTURER)
),
style = MaterialTheme.typography.h6,
modifier = Modifier.fillMaxWidth()
)
Text(
text = stringResource(R.string.intro_autostart_text),
style = MaterialTheme.typography.body1,
modifier = Modifier.padding(top = 12.dp)
)
OutlinedButton(
onClick = {
uriHandler.openUri(
Constants.HOMEPAGE_URL.buildUpon()
.appendPath(Constants.HOMEPAGE_PATH_FAQ)
.appendPath(Constants.HOMEPAGE_PATH_FAQ_SYNC_NOT_RUN)
.appendQueryParameter(
"manufacturer",
Build.MANUFACTURER.lowercase(Locale.ROOT)
)
.withStatParams("BatteryOptimizationsPage")
.build().toString()
)
}
) {
Text(stringResource(R.string.intro_more_info))
}
Row(
verticalAlignment = Alignment.CenterVertically
) {
Checkbox(
checked = dontShowAutostart,
onCheckedChange = onChangeDontShowAutostart
)
Text(
text = stringResource(R.string.intro_autostart_dont_show),
style = MaterialTheme.typography.body2,
modifier = Modifier
.clickable { onChangeDontShowAutostart(!dontShowAutostart) }
)
}
}
}
}
Text(
text = stringResource(
R.string.intro_leave_unchecked,
stringResource(R.string.app_settings_reset_hints)
),
style = MaterialTheme.typography.body2,
modifier = Modifier
.padding(top = 8.dp)
.padding(horizontal = 16.dp)
)
Spacer(modifier = Modifier.height(90.dp))
}

}
Loading
Loading