-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
This release approaches issues described above. Before promoting to production the release build must be tested with Internal Testers for avoiding possible ProGuard errors
- Loading branch information
1 parent
5f9820a
commit 29ecf03
Showing
9 changed files
with
457 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
321 changes: 321 additions & 0 deletions
321
app/src/main/java/com/javinator9889/handwashingreminder/custom/libraries/AppRate.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,321 @@ | ||
| /* | ||
| * Copyright © 2020 - present | Handwashing reminder by Javinator9889 | ||
| * | ||
| * 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 https://www.gnu.org/licenses/. | ||
| * | ||
| * Created by Javinator9889 on 29/04/20 - Handwashing reminder. | ||
| * | ||
| * Based on AppRate open source library: https://github.com/msfjarvis/AppRate | ||
| */ | ||
| @file:Suppress("unused") | ||
| package com.javinator9889.handwashingreminder.custom.libraries | ||
|
|
||
| import android.app.Activity | ||
| import android.content.ActivityNotFoundException | ||
| import android.content.Context | ||
| import android.content.Intent | ||
| import android.content.SharedPreferences | ||
| import android.content.pm.ApplicationInfo | ||
| import android.content.pm.PackageManager.NameNotFoundException | ||
| import android.net.Uri | ||
| import android.text.format.DateUtils | ||
| import android.widget.Toast | ||
| import androidx.annotation.StringRes | ||
| import com.afollestad.materialdialogs.MaterialDialog | ||
| import com.afollestad.materialdialogs.callbacks.onCancel | ||
| import timber.log.Timber | ||
|
|
||
| class AppRate(private val hostActivity: Activity) { | ||
| private val preferences: SharedPreferences = | ||
| hostActivity.getSharedPreferences(PrefsContract.SHARED_PREFS_NAME, 0) | ||
|
|
||
| private var minLaunchesUntilPrompt: Long = 0 | ||
| private var minDaysUntilPrompt: Long = 0 | ||
| private var customDialog: MaterialDialog? = null | ||
| private var positiveActionCallback: () -> Unit = | ||
| { throw NoCustomCallbackException() } | ||
| private var negativeActionCallback: () -> Unit? = | ||
| { throw NoCustomCallbackException() } | ||
|
|
||
| private var showIfHasCrashed = true | ||
|
|
||
| @StringRes | ||
| var dialogTitle: Int? = null | ||
|
|
||
| @StringRes | ||
| var dialogMessage: Int? = null | ||
|
|
||
| @StringRes | ||
| var positiveButtonText: Int? = null | ||
|
|
||
| @StringRes | ||
| var negativeButtonText: Int? = null | ||
|
|
||
| /** | ||
| * @param minLaunchesUntilPrompt The minimum number of times the | ||
| * * user lunches the application before showing the rate dialog.<br></br> | ||
| * * Default value is 0 times. | ||
| * * | ||
| * @return This [AppRate] object to allow chaining. | ||
| */ | ||
| fun setMinLaunchesUntilPrompt(minLaunchesUntilPrompt: Long): AppRate { | ||
| this.minLaunchesUntilPrompt = minLaunchesUntilPrompt | ||
| return this | ||
| } | ||
|
|
||
| /** | ||
| * @param minDaysUntilPrompt The minimum number of days before showing the rate dialog.<br></br> | ||
| * * Default value is 0 days. | ||
| * * | ||
| * @return This [AppRate] object to allow chaining. | ||
| */ | ||
| fun setMinDaysUntilPrompt(minDaysUntilPrompt: Long): AppRate { | ||
| this.minDaysUntilPrompt = minDaysUntilPrompt | ||
| return this | ||
| } | ||
|
|
||
| /** | ||
| * @param showIfCrash If `false` the rate dialog will | ||
| * * not be shown if the application has crashed once.<br></br> | ||
| * * Default value is `false`. | ||
| * * | ||
| * @return This [AppRate] object to allow chaining. | ||
| */ | ||
| fun setShowIfAppHasCrashed(showIfCrash: Boolean): AppRate { | ||
| showIfHasCrashed = showIfCrash | ||
| preferences.edit() | ||
| .putBoolean(PrefsContract.PREF_DONT_SHOW_IF_CRASHED, showIfCrash) | ||
| .apply() | ||
| return this | ||
| } | ||
|
|
||
| /** | ||
| * Use this method if you want to customize the style and content of the rate dialog.<br></br> | ||
| * When using the [MaterialDialog] you should use: | ||
| * | ||
| * * [MaterialDialog.positiveButton] for the **rate** button. | ||
| * * [MaterialDialog.negativeButton] for the **never rate** button. | ||
| * | ||
| * @param customDialog The custom dialog you want to use as the rate dialog. | ||
| * * | ||
| * @return This [AppRate] object to allow chaining. | ||
| */ | ||
| fun setCustomDialog(customDialog: MaterialDialog): AppRate { | ||
| this.customDialog = customDialog | ||
| return this | ||
| } | ||
|
|
||
| /** | ||
| * Display the rate dialog if needed. | ||
| */ | ||
| fun init() { | ||
|
|
||
| Timber.d("Init AppRate") | ||
|
|
||
| if (preferences.getBoolean(PrefsContract.PREF_DONT_SHOW_AGAIN, false) || | ||
| preferences.getBoolean(PrefsContract.PREF_APP_HAS_CRASHED, false) && | ||
| !showIfHasCrashed | ||
| ) { | ||
| return | ||
| } | ||
|
|
||
| if (!showIfHasCrashed) { | ||
| initExceptionHandler() | ||
| } | ||
|
|
||
| val editor = preferences.edit() | ||
|
|
||
| // Get and increment launch counter. | ||
| val launchCount = | ||
| preferences.getLong(PrefsContract.PREF_LAUNCH_COUNT, 0) + 1 | ||
| editor.putLong(PrefsContract.PREF_LAUNCH_COUNT, launchCount) | ||
|
|
||
| // Get date of first launch. | ||
| var dateFirstLaunch: Long? = | ||
| preferences.getLong(PrefsContract.PREF_DATE_FIRST_LAUNCH, 0) | ||
| if (dateFirstLaunch == 0L) { | ||
| dateFirstLaunch = System.currentTimeMillis() | ||
| editor.putLong( | ||
| PrefsContract.PREF_DATE_FIRST_LAUNCH, | ||
| dateFirstLaunch | ||
| ) | ||
| } | ||
|
|
||
| // Show the rate dialog if needed. | ||
| if (launchCount >= minLaunchesUntilPrompt) { | ||
| if (System.currentTimeMillis() >= dateFirstLaunch!! + minDaysUntilPrompt * DateUtils.DAY_IN_MILLIS) { | ||
| showDefaultDialog() | ||
| } | ||
| } | ||
|
|
||
| editor.apply() | ||
| } | ||
|
|
||
| /** | ||
| * Initialize the [ExceptionHandler]. | ||
| */ | ||
| private fun initExceptionHandler() { | ||
|
|
||
| Timber.d("Init AppRate ExceptionHandler") | ||
|
|
||
| val currentHandler = Thread.getDefaultUncaughtExceptionHandler() | ||
|
|
||
| // Don't register again if already registered. | ||
| if (currentHandler !is ExceptionHandler) { | ||
|
|
||
| // Register default exceptions handler. | ||
| Thread.setDefaultUncaughtExceptionHandler( | ||
| ExceptionHandler( | ||
| currentHandler, | ||
| hostActivity | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Shows the default rate dialog. | ||
| */ | ||
| private fun showDefaultDialog() { | ||
|
|
||
| Timber.d("Create default dialog.") | ||
|
|
||
| val title = dialogTitle?.let { hostActivity.getText(it) } | ||
| ?: "Rate ${getApplicationName(hostActivity.applicationContext)}" | ||
| val message = dialogMessage?.let { hostActivity.getText(it) } | ||
| ?: "If you enjoy using ${getApplicationName(hostActivity.applicationContext)}," + | ||
| " please take a moment to rate it. Thanks for your support!" | ||
| val rate = | ||
| positiveButtonText?.let { hostActivity.getText(it) } ?: "Rate it !" | ||
| val dismiss = | ||
| negativeButtonText?.let { hostActivity.getText(it) } ?: "No thanks" | ||
|
|
||
| MaterialDialog(hostActivity).apply { | ||
| title(text = title.toString()) | ||
| message(text = message) | ||
| positiveButton(text = rate) { onPositive() } | ||
| negativeButton(text = dismiss) { onNegative() } | ||
| onCancel { onCancel() } | ||
| show() | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Method called when the positiveButton callback | ||
| * is invoked. | ||
| */ | ||
| private fun onPositive() { | ||
| try { | ||
| positiveActionCallback() | ||
| } catch (ignored: NoCustomCallbackException) { | ||
| try { | ||
| hostActivity.startActivity( | ||
| Intent( | ||
| Intent.ACTION_VIEW, | ||
| Uri.parse("https://play.google.com/store/apps/details?id=" + hostActivity.packageName) | ||
| ) | ||
| ) | ||
| } catch (ignored: ActivityNotFoundException) { | ||
| Toast.makeText( | ||
| hostActivity, | ||
| "No Play Store installed on device", | ||
| Toast.LENGTH_SHORT | ||
| ).show() | ||
| } | ||
| } | ||
|
|
||
| preferences.edit().putBoolean(PrefsContract.PREF_DONT_SHOW_AGAIN, true) | ||
| .apply() | ||
| } | ||
|
|
||
| /** | ||
| * Method called when the negativeButton callback | ||
| * is invoked. | ||
| */ | ||
| private fun onNegative() { | ||
| try { | ||
| negativeActionCallback() | ||
| } catch (ignored: NoCustomCallbackException) { | ||
| preferences.edit() | ||
| .putBoolean(PrefsContract.PREF_DONT_SHOW_AGAIN, true).apply() | ||
| } | ||
| } | ||
|
|
||
| private fun onCancel() { | ||
| preferences.edit() | ||
| .putLong( | ||
| PrefsContract.PREF_DATE_FIRST_LAUNCH, | ||
| System.currentTimeMillis() | ||
| ) | ||
| .putLong(PrefsContract.PREF_LAUNCH_COUNT, 0) | ||
| .apply() | ||
| } | ||
|
|
||
| /** | ||
| * @param negativeActionCallback A Kotlin unit invoked when the negative action | ||
| * callback is triggered in the dialog. | ||
| * | ||
| * @return This [AppRate] object to allow chaining. | ||
| */ | ||
| fun setOnNegativeCallback(negativeActionCallback: () -> Unit): AppRate { | ||
| this.negativeActionCallback = negativeActionCallback | ||
| return this | ||
| } | ||
|
|
||
| /** | ||
| * @param positiveActionCallback A Kotlin unit invoked when the positive action | ||
| * callback is triggered in the dialog. | ||
| * | ||
| * @return This [AppRate] object to allow chaining. | ||
| */ | ||
| fun setOnPositiveCallback(positiveActionCallback: () -> Unit): AppRate { | ||
| this.positiveActionCallback = positiveActionCallback | ||
| return this | ||
| } | ||
|
|
||
| class NoCustomCallbackException : Exception() | ||
|
|
||
| companion object { | ||
|
|
||
| private const val TAG = "AppRate" | ||
|
|
||
| /** | ||
| * Reset all the data collected about number of launches and days until first launch. | ||
| * @param context A context. | ||
| */ | ||
| fun reset(context: Context) { | ||
| context.getSharedPreferences(PrefsContract.SHARED_PREFS_NAME, 0) | ||
| .edit().clear().apply() | ||
| Timber.d( "Cleared AppRate shared preferences.") | ||
| } | ||
|
|
||
| /** | ||
| * @param context A context of the current application. | ||
| * * | ||
| * @return The application name of the current application. | ||
| */ | ||
| private fun getApplicationName(context: Context): String { | ||
| val packageManager = context.packageManager | ||
| val applicationInfo: ApplicationInfo? | ||
| applicationInfo = try { | ||
| packageManager.getApplicationInfo(context.packageName, 0) | ||
| } catch (ignored: NameNotFoundException) { | ||
| null | ||
| } | ||
|
|
||
| return (if (applicationInfo != null) | ||
| packageManager.getApplicationLabel(applicationInfo) else "(unknown)") as String | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.