diff --git a/README.md b/README.md index e770ec9..95a4fdd 100644 --- a/README.md +++ b/README.md @@ -170,3 +170,11 @@ template for the eventual fdroiddata build recipe. LibreMail is licensed under the **GNU General Public License v3.0** — see [`LICENSE`](LICENSE). SPDX identifier: `GPL-3.0-or-later`. + +Onboarding requires agreeing to this license before anything else (#172); the screen that shows it +(`ui/onboarding/LicenseScreen.kt`) reads a bundled runtime copy at +`app/src/main/res/raw/license.txt` rather than this file directly. That copy is a byte-for-byte +duplicate, kept in sync by hand rather than generated at build time or annotated in place (the +in-app screen renders it verbatim, so any header/footer added to the copy would show up to the user +as if it were part of the license) — **if you edit `LICENSE`, copy the change into `license.txt` +too**, and vice versa. diff --git a/app/src/androidTest/kotlin/org/libremail/ui/onboarding/LicenseScreenTest.kt b/app/src/androidTest/kotlin/org/libremail/ui/onboarding/LicenseScreenTest.kt new file mode 100644 index 0000000..60cfba9 --- /dev/null +++ b/app/src/androidTest/kotlin/org/libremail/ui/onboarding/LicenseScreenTest.kt @@ -0,0 +1,92 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package org.libremail.ui.onboarding + +import androidx.activity.ComponentActivity +import androidx.compose.ui.test.assertIsEnabled +import androidx.compose.ui.test.assertIsNotEnabled +import androidx.compose.ui.test.junit4.createAndroidComposeRule +import androidx.compose.ui.test.onNodeWithTag +import androidx.compose.ui.test.onNodeWithText +import androidx.compose.ui.test.performClick +import androidx.compose.ui.test.performScrollTo +import androidx.test.espresso.Espresso +import androidx.test.ext.junit.runners.AndroidJUnit4 +import org.junit.Assert.assertTrue +import org.junit.Rule +import org.junit.Test +import org.junit.runner.RunWith +import org.libremail.R +import org.libremail.ui.theme.LibreMailTheme + +/** + * Component test for [LicenseScreen] (#172), in isolation from the real onboarding nav graph (that + * wiring — persisting acceptance, popping the license off the back stack, calling `finish()` on + * Decline — belongs to `onboardingGraph()` in `LibreMailApp.kt`, not this composable). This test only + * owns the screen's own contract: Agree is gated on having scrolled to the end, Decline (and back) + * always works, and the real bundled GPL-3.0 text actually renders. + */ +@RunWith(AndroidJUnit4::class) +class LicenseScreenTest { + + @get:Rule + val composeTestRule = createAndroidComposeRule() + + private fun string(resId: Int) = composeTestRule.activity.getString(resId) + + private fun setContent(onAgree: () -> Unit = {}, onDecline: () -> Unit = {}) { + composeTestRule.setContent { + LibreMailTheme(darkTheme = false, dynamicColor = false) { + LicenseScreen(onAgree = onAgree, onDecline = onDecline) + } + } + } + + @Test + fun licenseText_rendersTheRealBundledGplText() { + setContent() + + // Proves res/raw/license.txt actually loaded, not just that some placeholder text exists — + // an empty or missing resource would make agreeButton_isDisabledUntilScrolledToTheEnd below + // pass for the wrong reason (nothing to scroll). + composeTestRule.onNodeWithText("GNU GENERAL PUBLIC LICENSE", substring = true).assertExists() + } + + @Test + fun agreeButton_isDisabledUntilScrolledToTheEnd() { + setContent() + + composeTestRule.onNodeWithText(string(R.string.license_agree)).assertIsNotEnabled() + } + + @Test + fun agreeButton_scrolledToEnd_becomesEnabledAndInvokesOnAgree() { + var agreed = false + setContent(onAgree = { agreed = true }) + + composeTestRule.onNodeWithTag(LICENSE_SCROLL_END_TAG).performScrollTo() + + composeTestRule.onNodeWithText(string(R.string.license_agree)).assertIsEnabled().performClick() + assertTrue(agreed) + } + + @Test + fun declineButton_worksWithoutScrolling_andInvokesOnDecline() { + var declined = false + setContent(onDecline = { declined = true }) + + // No scrolling first: Decline must never be gated the way Agree is. + composeTestRule.onNodeWithText(string(R.string.license_decline)).assertIsEnabled().performClick() + + assertTrue(declined) + } + + @Test + fun systemBack_invokesOnDeclineJustLikeTheButton() { + var declined = false + setContent(onDecline = { declined = true }) + + Espresso.pressBack() + + assertTrue(declined) + } +} diff --git a/app/src/androidTest/kotlin/org/libremail/ui/onboarding/OnboardingFlowTest.kt b/app/src/androidTest/kotlin/org/libremail/ui/onboarding/OnboardingFlowTest.kt index ff116c8..065d0e3 100644 --- a/app/src/androidTest/kotlin/org/libremail/ui/onboarding/OnboardingFlowTest.kt +++ b/app/src/androidTest/kotlin/org/libremail/ui/onboarding/OnboardingFlowTest.kt @@ -99,6 +99,12 @@ class OnboardingFlowTest { // Real collaborators are cheap here: the manager just wraps PowerManager and the repository // reads the on-device settings DataStore. This test drives its own nav graph (without the // battery step), so the onboarding view model's battery decision is inert for this flow. + // + // This hand-rolled graph starts at ONBOARDING_WELCOME directly, deliberately bypassing the + // GPL-3.0 license gate (#172) that precedes it in the real onboardingGraph() in + // LibreMailApp.kt: this test owns the picker → setup → finish tail, not the license screen's + // own contract (scroll-to-agree, decline-exits, hard-gating), which LicenseScreenTest covers + // in isolation instead. val appContext = composeTestRule.activity.applicationContext val onboarding = OnboardingViewModel( BatteryOptimizationManager(appContext), diff --git a/app/src/main/kotlin/org/libremail/data/settings/SettingsRepository.kt b/app/src/main/kotlin/org/libremail/data/settings/SettingsRepository.kt index 6dd8bfc..2d04e60 100644 --- a/app/src/main/kotlin/org/libremail/data/settings/SettingsRepository.kt +++ b/app/src/main/kotlin/org/libremail/data/settings/SettingsRepository.kt @@ -65,6 +65,14 @@ data class AppSettings( * treat it as a hint to validate against the current account list, never as a trusted id. */ val defaultAccountId: String? = null, + /** + * Whether the user has agreed to the bundled GPL-3.0 license (issue #172). Gates + * `onboardingGraph`'s start destination in `LibreMailApp.kt`: unaccepted routes through + * `Routes.ONBOARDING_LICENSE` first; already-accepted skips straight to + * `Routes.ONBOARDING_WELCOME`. Persisted rather than re-asked every launch, so a user who agrees + * but exits (or whose process dies) before adding an account isn't forced to agree again. + */ + val licenseAccepted: Boolean = false, ) private object Keys { @@ -80,6 +88,7 @@ private object Keys { val RETENTION_COUNT = intPreferencesKey("retention_count") val RETENTION_MONTHS = intPreferencesKey("retention_months") val DEFAULT_ACCOUNT_ID = stringPreferencesKey("default_account_id") + val LICENSE_ACCEPTED = booleanPreferencesKey("license_accepted") val BATTERY_PROMPT_HANDLED = booleanPreferencesKey("battery_prompt_handled") val CONTACTS_PROMPT_HANDLED = booleanPreferencesKey("contacts_prompt_handled") val CONTACTS_PERMISSION_REQUESTED = booleanPreferencesKey("contacts_permission_requested") @@ -106,6 +115,7 @@ internal fun Preferences.toAppSettings(): AppSettings = AppSettings( retentionCount = this[Keys.RETENTION_COUNT] ?: 0, retentionMonths = this[Keys.RETENTION_MONTHS] ?: 0, defaultAccountId = this[Keys.DEFAULT_ACCOUNT_ID], + licenseAccepted = this[Keys.LICENSE_ACCEPTED] ?: false, ) @Singleton @@ -161,6 +171,9 @@ class SettingsRepository @Inject constructor(@ApplicationContext private val con suspend fun setEncryptCache(value: Boolean) = put(Keys.ENCRYPT_CACHE, value) suspend fun setAppLock(value: Boolean) = put(Keys.APP_LOCK, value) + /** Records that the user agreed to the license (#172), so onboarding never shows it again. */ + suspend fun setLicenseAccepted(value: Boolean) = put(Keys.LICENSE_ACCEPTED, value) + /** * Opts this app in/out of system Android Backup. Off by default. After persisting, nudges the * framework so the change takes effect on the next backup pass — enabling schedules a backup of diff --git a/app/src/main/kotlin/org/libremail/ui/AppViewModel.kt b/app/src/main/kotlin/org/libremail/ui/AppViewModel.kt index a87ed2a..ace2c7e 100644 --- a/app/src/main/kotlin/org/libremail/ui/AppViewModel.kt +++ b/app/src/main/kotlin/org/libremail/ui/AppViewModel.kt @@ -9,6 +9,7 @@ import kotlinx.coroutines.flow.StateFlow import kotlinx.coroutines.flow.map import kotlinx.coroutines.flow.stateIn import kotlinx.coroutines.flow.take +import org.libremail.data.settings.SettingsRepository import org.libremail.domain.repository.AccountRepository import org.libremail.ui.navigation.Routes import javax.inject.Inject @@ -23,10 +24,24 @@ import javax.inject.Inject * start destination and tear down the in-progress flow. */ @HiltViewModel -class AppViewModel @Inject constructor(accountRepository: AccountRepository) : ViewModel() { +class AppViewModel @Inject constructor(accountRepository: AccountRepository, settingsRepository: SettingsRepository) : + ViewModel() { val startDestination: StateFlow = accountRepository.observeAccounts() .map { accounts -> if (accounts.isEmpty()) Routes.ONBOARDING else Routes.MAILBOX } .take(1) .stateIn(viewModelScope, SharingStarted.Eagerly, null) + + /** + * Whether the user has already agreed to the GPL-3.0 license (#172), resolved once at launch + * exactly like [startDestination] (same "hold until known, then never re-decide" contract). + * [LibreMailApp][org.libremail.ui.LibreMailApp] holds off building its `NavHost` until this is + * known too, because the onboarding graph — and therefore its choice of start destination between + * `Routes.ONBOARDING_LICENSE` and `Routes.ONBOARDING_WELCOME` — is registered as part of that same + * `NavHost` regardless of whether [startDestination] itself resolves to onboarding or the mailbox. + */ + val licenseAccepted: StateFlow = settingsRepository.settings + .map { it.licenseAccepted } + .take(1) + .stateIn(viewModelScope, SharingStarted.Eagerly, null) } diff --git a/app/src/main/kotlin/org/libremail/ui/LibreMailApp.kt b/app/src/main/kotlin/org/libremail/ui/LibreMailApp.kt index 1d33c9f..fa6e750 100644 --- a/app/src/main/kotlin/org/libremail/ui/LibreMailApp.kt +++ b/app/src/main/kotlin/org/libremail/ui/LibreMailApp.kt @@ -1,6 +1,7 @@ // SPDX-License-Identifier: GPL-3.0-or-later package org.libremail.ui +import androidx.activity.compose.LocalActivity import androidx.compose.foundation.layout.Row import androidx.compose.material3.AlertDialog import androidx.compose.material3.Icon @@ -38,6 +39,7 @@ import org.libremail.ui.navigation.Routes import org.libremail.ui.onboarding.AddAnotherAccountScreen import org.libremail.ui.onboarding.BatteryOptimizationScreen import org.libremail.ui.onboarding.ContactsAccessScreen +import org.libremail.ui.onboarding.LicenseScreen import org.libremail.ui.onboarding.OnboardingViewModel import org.libremail.ui.onboarding.OnboardingWelcomeScreen import org.libremail.ui.outbox.OutboxScreen @@ -60,9 +62,12 @@ fun LibreMailApp( onOpenMessageHandled: () -> Unit = {}, ) { val startDestination by appViewModel.startDestination.collectAsStateWithLifecycle() - // Hold (render nothing) until the account count is known, so a cold start never flashes the - // wrong screen before onboarding-vs-mailbox is decided. + val licenseAccepted by appViewModel.licenseAccepted.collectAsStateWithLifecycle() + // Hold (render nothing) until the account count AND the license-acceptance flag are known, so a + // cold start never flashes the wrong screen before onboarding-vs-mailbox — and, within onboarding, + // license-vs-welcome (#172) — is decided. val start = startDestination ?: return + val licenseAlreadyAccepted = licenseAccepted ?: return val navController = rememberNavController() val pendingCrash by startupViewModel.pendingCrash.collectAsStateWithLifecycle() @@ -95,7 +100,7 @@ fun LibreMailApp( navController = navController, startDestination = start, ) { - onboardingGraph(navController) + onboardingGraph(navController, licenseAlreadyAccepted) composable( route = Routes.MAILBOX_PATTERN, @@ -286,9 +291,31 @@ private fun CrashReportDialog(onReview: () -> Unit, onLater: () -> Unit, onDisca * first account added this session. The picker/setup screens are the same composables used by the * top-level "Add account" routes; here, a successful add routes to the "add another?" prompt instead * of popping back. + * + * @param licenseAlreadyAccepted decides the graph's start destination (#172): false routes through + * [Routes.ONBOARDING_LICENSE] first; true (the user already agreed on a prior run) skips straight to + * [Routes.ONBOARDING_WELCOME], matching this graph's pre-#172 behavior. */ -private fun NavGraphBuilder.onboardingGraph(navController: NavHostController) { - navigation(startDestination = Routes.ONBOARDING_WELCOME, route = Routes.ONBOARDING) { +private fun NavGraphBuilder.onboardingGraph(navController: NavHostController, licenseAlreadyAccepted: Boolean) { + val onboardingStart = if (licenseAlreadyAccepted) Routes.ONBOARDING_WELCOME else Routes.ONBOARDING_LICENSE + navigation(startDestination = onboardingStart, route = Routes.ONBOARDING) { + composable(Routes.ONBOARDING_LICENSE) { entry -> + val onboarding = onboardingViewModel(navController, entry) + val activity = LocalActivity.current + LicenseScreen( + onAgree = { + onboarding.markLicenseAccepted() + // Pop LICENSE off the back stack: it is a one-time gate, so a later back-press + // from the welcome screen must not be able to return to it. + navController.navigate(Routes.ONBOARDING_WELCOME) { + popUpTo(Routes.ONBOARDING_LICENSE) { inclusive = true } + } + }, + // MainActivity is this app's only Activity (single-activity Compose app), so finish() + // is sufficient to exit outright (#172). + onDecline = { activity?.finish() }, + ) + } composable(Routes.ONBOARDING_WELCOME) { OnboardingWelcomeScreen(onAddAccount = { navController.navigate(Routes.ONBOARDING_PICKER) }) } diff --git a/app/src/main/kotlin/org/libremail/ui/navigation/Routes.kt b/app/src/main/kotlin/org/libremail/ui/navigation/Routes.kt index 3659bb9..3c9b1da 100644 --- a/app/src/main/kotlin/org/libremail/ui/navigation/Routes.kt +++ b/app/src/main/kotlin/org/libremail/ui/navigation/Routes.kt @@ -31,6 +31,12 @@ object Routes { // ViewModel, so the picker/setup screens are registered inside it for onboarding and reused as // the top-level ACCOUNT_SETUP / APP_PASSWORD / MANUAL_SETUP routes for "Add account" later. const val ONBOARDING = "onboarding" + + // The graph's actual start destination whenever SettingsRepository.licenseAccepted is false + // (#172): the user must scroll through the GPL-3.0 text and tap Agree before reaching anything + // else. An already-accepted user skips straight to ONBOARDING_WELCOME instead — see + // onboardingGraph() in LibreMailApp.kt. + const val ONBOARDING_LICENSE = "onboarding/license" const val ONBOARDING_WELCOME = "onboarding/welcome" const val ONBOARDING_PICKER = "onboarding/picker" const val ONBOARDING_MANUAL = "onboarding/manual" diff --git a/app/src/main/kotlin/org/libremail/ui/onboarding/LicenseScreen.kt b/app/src/main/kotlin/org/libremail/ui/onboarding/LicenseScreen.kt new file mode 100644 index 0000000..5a92e1a --- /dev/null +++ b/app/src/main/kotlin/org/libremail/ui/onboarding/LicenseScreen.kt @@ -0,0 +1,128 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package org.libremail.ui.onboarding + +import androidx.activity.compose.BackHandler +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.layout.size +import androidx.compose.foundation.layout.width +import androidx.compose.foundation.rememberScrollState +import androidx.compose.foundation.verticalScroll +import androidx.compose.material3.Button +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.OutlinedButton +import androidx.compose.material3.Scaffold +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.runtime.getValue +import androidx.compose.runtime.remember +import androidx.compose.ui.Modifier +import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.platform.testTag +import androidx.compose.ui.res.stringResource +import androidx.compose.ui.unit.dp +import org.libremail.R + +/** + * First screen of onboarding (#172): the user must scroll through the full GPL-3.0 license text and + * tap Agree before reaching [OnboardingWelcomeScreen] or anything else in the app; Decline exits + * instead. This is the onboarding graph's start destination whenever + * [org.libremail.data.settings.SettingsRepository.licenseAccepted] is false — see `onboardingGraph()` + * in `ui/LibreMailApp.kt`, which also owns persisting the Agree decision and wiring Decline to + * `Activity.finish()`. + * + * The bundled text at `res/raw/license.txt` is a byte-for-byte copy of the repo-root `LICENSE` file, + * kept that way deliberately: `Text` below renders it verbatim with no reflow logic to strip or + * reformat anything, so any header/footer added to the raw resource would show up to the user as + * part of the "license" they're agreeing to. Cross-reference comments therefore live *outside* the + * resource itself — see the "License" section of README.md — rather than inside it; if `LICENSE` + * changes, copy the change into `license.txt` too so the two don't drift. + * + * @param onAgree invoked when the user taps Agree; only reachable once scrolled to the end. + * @param onDecline invoked when the user taps Decline, or presses back (there is nothing before this + * screen to return to — see [BackHandler] below). + */ +@Composable +fun LicenseScreen(onAgree: () -> Unit, onDecline: () -> Unit) { + val scrollState = rememberScrollState() + val licenseText = rememberLicenseText() + // Also correctly resolves the "whole license fits on one screen, nothing to scroll" case: when + // no scrolling is needed, maxValue is 0 and 0 >= 0 is trivially true. + val scrolledToEnd = scrollState.value >= scrollState.maxValue + + // This screen is the onboarding graph's start destination, so there is nothing before it to pop + // back to: back is wired to the exact same exit path as Decline instead of left to fall through + // to the platform default (which would also finish the single Activity, but only implicitly). + BackHandler(onBack = onDecline) + + Scaffold { padding -> + Column( + modifier = Modifier + .fillMaxSize() + .padding(padding) + .padding(24.dp), + ) { + Text( + text = stringResource(R.string.license_title), + style = MaterialTheme.typography.headlineSmall, + ) + Spacer(Modifier.height(8.dp)) + Text( + text = stringResource(R.string.license_intro), + style = MaterialTheme.typography.bodyMedium, + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) + Spacer(Modifier.height(16.dp)) + // Only the license text scrolls; Agree/Decline stay pinned below it so they are visible + // the whole time — Agree simply flips enabled once scrolledToEnd — rather than being the + // last item in one big scrolling column the way AppPasswordSetupScreen/ManualSetupScreen/ + // ReportReviewScreen scroll their form fields. Same rememberScrollState() + + // Modifier.verticalScroll gating those screens use either way (scrollState.value >= + // scrollState.maxValue) — just scoped to the text pane instead of the whole screen, which + // reads better for a "you must read this" gate than a submit button that only appears + // once you've already scrolled past everything. + Column( + modifier = Modifier + .weight(1f) + .verticalScroll(scrollState), + ) { + Text(text = licenseText, style = MaterialTheme.typography.bodySmall) + // Zero-visual-footprint marker at the true end of the scrollable content, so + // LicenseScreenTest can performScrollTo() it directly instead of simulating repeated + // swipes (which would be flaky given the content's unknown rendered height). + Spacer(Modifier.size(1.dp).testTag(LICENSE_SCROLL_END_TAG)) + } + Spacer(Modifier.height(16.dp)) + Row(modifier = Modifier.fillMaxWidth()) { + OutlinedButton(onClick = onDecline, modifier = Modifier.weight(1f)) { + Text(stringResource(R.string.license_decline)) + } + Spacer(Modifier.width(12.dp)) + Button(onClick = onAgree, enabled = scrolledToEnd, modifier = Modifier.weight(1f)) { + Text(stringResource(R.string.license_agree)) + } + } + } + } +} + +/** Loads `res/raw/license.txt` once per composition; a ~35KB local resource read is negligible. */ +@Composable +private fun rememberLicenseText(): String { + val context = LocalContext.current + return remember { + context.resources.openRawResource(R.raw.license).bufferedReader().use { it.readText() } + } +} + +/** + * Test tag on the sentinel marking the end of the scrollable license text. Internal (not private) so + * `LicenseScreenTest` (androidTest) can target it directly — see `IntentHandledMarker` in + * `MainActivity.kt` for the same internal-for-androidTest-visibility pattern. + */ +internal const val LICENSE_SCROLL_END_TAG = "license_scroll_end" diff --git a/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingViewModel.kt b/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingViewModel.kt index ab55a2d..079e31b 100644 --- a/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingViewModel.kt +++ b/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingViewModel.kt @@ -101,6 +101,11 @@ class OnboardingViewModel @Inject constructor( viewModelScope.launch { settingsRepository.setBatteryPromptHandled(true) } } + /** Record that the user agreed to the license (#172) so onboarding never shows it again. */ + fun markLicenseAccepted() { + viewModelScope.launch { settingsRepository.setLicenseAccepted(true) } + } + /** Re-read the live `READ_CONTACTS` grant; call when the contacts step resumes. */ fun refreshContactsStatus() { _contactsGranted.value = contactsPermissionManager.hasPermission() diff --git a/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingWelcomeScreen.kt b/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingWelcomeScreen.kt index 1eb6d5b..a0cf82b 100644 --- a/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingWelcomeScreen.kt +++ b/app/src/main/kotlin/org/libremail/ui/onboarding/OnboardingWelcomeScreen.kt @@ -35,7 +35,9 @@ import org.libremail.R /** * First-run welcome. Invites the user to connect their first mailbox and hands off to the vendor - * picker. Shown as the onboarding start destination when the app launches with no accounts. + * picker. Shown once the user has agreed to the GPL-3.0 license (see `LicenseScreen.kt`, #172): the + * onboarding graph's start destination when no accounts exist and the license hasn't been accepted + * yet; an already-accepted user lands here directly, same as before #172. */ @Composable fun OnboardingWelcomeScreen(onAddAccount: () -> Unit) { @@ -43,6 +45,12 @@ fun OnboardingWelcomeScreen(onAddAccount: () -> Unit) { // once this screen (with onboarding context behind it) is actually visible instead of racing // the cold-start/splash transition (#151). Already-onboarded users skip onboarding entirely, so // this composable — and the request — never runs for them. + // + // #172 inserted the license-agreement screen ahead of this one, so this is now the SECOND + // onboarding screen, not the first — but the request stays here rather than moving earlier: it + // must fire only once onboarding context is visible, which now additionally means only after the + // user has agreed to the license. Do not call NotificationPermissionEffect() from + // LicenseScreen.kt. NotificationPermissionEffect() Scaffold { padding -> WelcomeContent( diff --git a/app/src/main/res/raw/license.txt b/app/src/main/res/raw/license.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/app/src/main/res/raw/license.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index 8134527..4866d82 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -155,6 +155,12 @@ Expand attachments Collapse attachments + + License agreement + LibreMail is free software, licensed under the GNU General Public License version 3. Please read it below, then Agree to continue or Decline to exit. + Agree + Decline + Welcome to LibreMail A private, open-source home for all your email. Add your first account to get started. diff --git a/app/src/test/kotlin/org/libremail/data/settings/AppSettingsTest.kt b/app/src/test/kotlin/org/libremail/data/settings/AppSettingsTest.kt index 65d62dc..f003dc8 100644 --- a/app/src/test/kotlin/org/libremail/data/settings/AppSettingsTest.kt +++ b/app/src/test/kotlin/org/libremail/data/settings/AppSettingsTest.kt @@ -1,6 +1,7 @@ // SPDX-License-Identifier: GPL-3.0-or-later package org.libremail.data.settings +import androidx.datastore.preferences.core.booleanPreferencesKey import androidx.datastore.preferences.core.emptyPreferences import androidx.datastore.preferences.core.preferencesOf import androidx.datastore.preferences.core.stringPreferencesKey @@ -11,10 +12,15 @@ import kotlin.test.assertEquals * Full-content prefetch must default to Wi-Fi-only (#88) — both for fresh installs (the [AppSettings] * default) and for existing installs that never touched the setting (the DataStore-read fallback in * [toAppSettings]); an explicit user choice always wins. + * + * Also covers `licenseAccepted` (#172), the same kind of default/fallback mapping but for a plain + * boolean: unset must read back as "not yet accepted" so a fresh install (and any pre-#172 install + * that never wrote the key) is routed through `Routes.ONBOARDING_LICENSE` rather than skipping it. */ class AppSettingsTest { private val fetchPolicyKey = stringPreferencesKey("fetch_policy") + private val licenseAcceptedKey = booleanPreferencesKey("license_accepted") @Test fun `in-memory default fetch policy is WIFI_ONLY`() { @@ -37,4 +43,20 @@ class AppSettingsTest { val prefs = preferencesOf(fetchPolicyKey to "NOT_A_POLICY") assertEquals(FetchPolicy.WIFI_ONLY, prefs.toAppSettings().fetchPolicy) } + + @Test + fun `in-memory default has not accepted the license`() { + assertEquals(false, AppSettings().licenseAccepted) + } + + @Test + fun `a never-set license flag reads back as not accepted`() { + assertEquals(false, emptyPreferences().toAppSettings().licenseAccepted) + } + + @Test + fun `an accepted license persists and round-trips`() { + val prefs = preferencesOf(licenseAcceptedKey to true) + assertEquals(true, prefs.toAppSettings().licenseAccepted) + } } diff --git a/app/src/test/kotlin/org/libremail/ui/AppViewModelTest.kt b/app/src/test/kotlin/org/libremail/ui/AppViewModelTest.kt new file mode 100644 index 0000000..4b63a43 --- /dev/null +++ b/app/src/test/kotlin/org/libremail/ui/AppViewModelTest.kt @@ -0,0 +1,90 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package org.libremail.ui + +import io.mockk.every +import io.mockk.mockk +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.flow.flowOf +import kotlinx.coroutines.test.UnconfinedTestDispatcher +import kotlinx.coroutines.test.resetMain +import kotlinx.coroutines.test.runTest +import kotlinx.coroutines.test.setMain +import org.junit.After +import org.junit.Before +import org.junit.Test +import org.libremail.data.settings.AppSettings +import org.libremail.data.settings.SettingsRepository +import org.libremail.domain.model.Account +import org.libremail.domain.model.AuthType +import org.libremail.domain.model.MailSecurity +import org.libremail.domain.model.ServerConfig +import org.libremail.domain.repository.AccountRepository +import org.libremail.ui.navigation.Routes +import kotlin.test.assertEquals + +/** + * [AppViewModel] decides two independent things, each resolved once at launch: the top-level start + * destination (onboarding vs. mailbox, from the stored account count) and, since #172, whether the + * user has already agreed to the license (consulted by `onboardingGraph()` in `LibreMailApp.kt` to + * pick between `Routes.ONBOARDING_LICENSE` and `Routes.ONBOARDING_WELCOME`). Both repositories are + * mocked: [AccountRepository] and [SettingsRepository] are interfaces/classes this ViewModel only + * reads from, and `SettingsRepository` itself needs a real `Context` it doesn't get in a JVM test. + */ +@OptIn(ExperimentalCoroutinesApi::class) +class AppViewModelTest { + + private val testDispatcher = UnconfinedTestDispatcher() + + @Before + fun setUp() = Dispatchers.setMain(testDispatcher) + + @After + fun tearDown() = Dispatchers.resetMain() + + private fun account(id: String = "imap:me@example.com") = Account( + id = id, + email = "me@example.com", + displayName = "me@example.com", + authType = AuthType.PASSWORD_IMAP, + imap = ServerConfig("imap.example.com", 993, MailSecurity.SSL_TLS), + smtp = ServerConfig("smtp.example.com", 587, MailSecurity.STARTTLS), + ) + + private fun accountRepository(accounts: List = emptyList()) = mockk { + every { observeAccounts() } returns flowOf(accounts) + } + + private fun settingsRepository(licenseAccepted: Boolean = false) = mockk { + every { settings } returns flowOf(AppSettings(licenseAccepted = licenseAccepted)) + } + + @Test + fun `no accounts resolves onboarding as the start destination`() = runTest(testDispatcher) { + val vm = AppViewModel(accountRepository(emptyList()), settingsRepository()) + + assertEquals(Routes.ONBOARDING, vm.startDestination.value) + } + + @Test + fun `an existing account resolves the mailbox as the start destination`() = runTest(testDispatcher) { + val vm = AppViewModel(accountRepository(listOf(account())), settingsRepository()) + + assertEquals(Routes.MAILBOX, vm.startDestination.value) + } + + @Test + fun `license acceptance defaults to not accepted`() = runTest(testDispatcher) { + val vm = AppViewModel(accountRepository(), settingsRepository(licenseAccepted = false)) + + assertEquals(false, vm.licenseAccepted.value) + } + + @Test + fun `a previously accepted license is reflected so onboarding can skip straight to welcome`() = + runTest(testDispatcher) { + val vm = AppViewModel(accountRepository(), settingsRepository(licenseAccepted = true)) + + assertEquals(true, vm.licenseAccepted.value) + } +} diff --git a/app/src/test/kotlin/org/libremail/ui/onboarding/OnboardingViewModelTest.kt b/app/src/test/kotlin/org/libremail/ui/onboarding/OnboardingViewModelTest.kt index dcf8d00..2228d51 100644 --- a/app/src/test/kotlin/org/libremail/ui/onboarding/OnboardingViewModelTest.kt +++ b/app/src/test/kotlin/org/libremail/ui/onboarding/OnboardingViewModelTest.kt @@ -134,6 +134,17 @@ class OnboardingViewModelTest { coVerify { repo.setBatteryPromptHandled(true) } } + @Test + fun `marking the license accepted persists the flag`() = runTest(testDispatcher) { + val repo = settingsRepository() + coEvery { repo.setLicenseAccepted(any()) } just Runs + val vm = viewModel(settings = repo) + + vm.markLicenseAccepted() + + coVerify { repo.setLicenseAccepted(true) } + } + @Test fun `marking the contacts prompt handled persists the flag`() = runTest(testDispatcher) { val repo = settingsRepository()