Skip to content

Commit

Permalink
Refactor DeckUtils and CardAnalysisWidget for Improved Deck Handling
Browse files Browse the repository at this point in the history
  • Loading branch information
@xenonnn4w
xenonnn4w committed Sep 1, 2024
1 parent 3e844ff commit 756ff6a
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 86 deletions.
86 changes: 36 additions & 50 deletions AnkiDroid/src/main/java/com/ichi2/anki/DeckUtils.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,57 +17,43 @@
package com.ichi2.anki

import com.ichi2.anki.CollectionManager.withCol
import com.ichi2.libanki.Decks
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
import com.ichi2.libanki.Collection
import com.ichi2.libanki.Consts

object DeckUtils {

/**
* Checks if a given deck, including its subdecks if specified, is empty.
*
* @param decks The [Decks] instance containing the decks to check.
* @param deckId The ID of the deck to check.
* @param includeSubdecks If true, includes subdecks in the check. Default is true.
* @return `true` if the deck (and subdecks if specified) is empty, otherwise `false`.
*/
private fun isDeckEmpty(decks: Decks, deckId: Long, includeSubdecks: Boolean = true): Boolean {
val deckIds = decks.deckAndChildIds(deckId)
val totalCardCount = decks.cardCount(*deckIds.toLongArray(), includeSubdecks = includeSubdecks)
return totalCardCount == 0
}
/**
* Checks if a given deck, including its subdecks if specified, is empty.
*
* @param deckId The ID of the deck to check.
* @param includeSubdecks If true, includes subdecks in the check. Default is true.
* @return `true` if the deck (and subdecks if specified) is empty, otherwise `false`.
*/
private fun Collection.isDeckEmpty(deckId: Long, includeSubdecks: Boolean = true): Boolean {
val deckIds = decks.deckAndChildIds(deckId)
val totalCardCount = decks.cardCount(*deckIds.toLongArray(), includeSubdecks = includeSubdecks)
return totalCardCount == 0
}

/**
* Checks if the default deck is empty.
*
* This method runs on an IO thread and accesses the collection to determine if the default deck (with ID 1) is empty.
*
* @return `true` if the default deck is empty, otherwise `false`.
*/
suspend fun isDefaultDeckEmpty(): Boolean {
val defaultDeckId = 1L
return withContext(Dispatchers.IO) {
withCol {
isDeckEmpty(decks, defaultDeckId)
}
}
}
/**
* Checks if the default deck is empty.
*
* This method runs on an IO thread and accesses the collection to determine if the default deck (with ID 1) is empty.
*
* @return `true` if the default deck is empty, otherwise `false`.
*/
suspend fun isDefaultDeckEmpty(): Boolean = withCol { isDeckEmpty(Consts.DEFAULT_DECK_ID) }

/**
* Returns whether the deck picker displays any deck.
* Technically, it means that there is a non default deck, or that the default deck is non-empty.
*
* This function is specifically implemented to address an issue where the default deck
* isn't handled correctly when a second deck is added to the
* collection. In this case, the deck tree may incorrectly appear as non-empty when it contains
* only the default deck and no other cards.
*
*/
suspend fun isCollectionEmpty(): Boolean {
val tree = withCol { sched.deckDueTree() }
if (tree.children.size == 1 && tree.children[0].did == 1L) {
return isDefaultDeckEmpty()
}
return false
}
/**
* Returns whether the deck picker displays any deck.
* Technically, it means that there is a non-default deck, or that the default deck is non-empty.
*
* This function is specifically implemented to address an issue where the default deck
* isn't handled correctly when a second deck is added to the
* collection. In this case, the deck tree may incorrectly appear as non-empty when it contains
* only the default deck and no other cards.
*
*/
suspend fun isCollectionEmpty(): Boolean {
val tree = withCol { sched.deckDueTree() }
val onlyDefaultDeckAvailable = tree.children.singleOrNull()?.did == Consts.DEFAULT_DECK_ID
return onlyDefaultDeckAvailable && isDefaultDeckEmpty()
}
56 changes: 35 additions & 21 deletions AnkiDroid/src/main/java/com/ichi2/widget/cardanalysis/CardAnalysisWidget.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ import android.view.View
import android.widget.RemoteViews
import com.ichi2.anki.AnkiDroidApp
import com.ichi2.anki.CrashReportService
import com.ichi2.anki.DeckUtils
import com.ichi2.anki.R
import com.ichi2.anki.Reviewer
import com.ichi2.anki.analytics.UsageAnalytics
import com.ichi2.anki.isCollectionEmpty
import com.ichi2.anki.pages.DeckOptions
import com.ichi2.libanki.DeckId
import com.ichi2.widget.ACTION_UPDATE_WIDGET
Expand Down Expand Up @@ -60,35 +60,37 @@ class CardAnalysisWidget : AnalyticsWidgetProvider() {
* Updates the widget with the deck data.
*
* This method updates the widget view content with the deck data corresponding
* to the provided deck ID. If the deck is deleted, the widget will be cleared.
* to the provided deck ID. If the deck is deleted, the widget will be show a message "Missing deck. Please reconfigure".
*
* @param context the context of the application
* @param appWidgetManager the AppWidgetManager instance
* @param appWidgetId the ID of the app widget
* @param deckId the ID of the deck to be displayed in the widget.
*/
fun updateWidget(
context: Context,
appWidgetManager: AppWidgetManager,
appWidgetId: Int,
deckId: DeckId?
appWidgetId: Int
) {
val deckId = getDeckIdForWidget(context, appWidgetId)
val remoteViews = RemoteViews(context.packageName, R.layout.widget_card_analysis)

if (deckId == null) {
// Deck ID is not set or is invalid, to clear the saved preference.
CardAnalysisWidgetPreferences(context).saveSelectedDeck(appWidgetId, null)
showMissingDeck(context, appWidgetManager, appWidgetId, remoteViews)
return
}

AnkiDroidApp.applicationScope.launch {
val isCollectionEmpty = DeckUtils.isCollectionEmpty()
val isCollectionEmpty = isCollectionEmpty()
if (isCollectionEmpty) {
showCollectionDeck(context, appWidgetManager, appWidgetId, remoteViews)
return@launch
}

val deckData = getDeckNameAndStats(deckId)

if (deckData == null) {
// If the deck was deleted, clear the stored deck ID
// The deck was found but no data could be fetched, so update the preferences to remove the deck.
CardAnalysisWidgetPreferences(context).saveSelectedDeck(appWidgetId, null)
showMissingDeck(context, appWidgetManager, appWidgetId, remoteViews)
return@launch
Expand All @@ -97,6 +99,11 @@ class CardAnalysisWidget : AnalyticsWidgetProvider() {
}
}

private fun getDeckIdForWidget(context: Context, appWidgetId: Int): DeckId? {
val widgetPreferences = CardAnalysisWidgetPreferences(context)
return widgetPreferences.getSelectedDeckIdFromPreferences(appWidgetId)
}

private fun showCollectionDeck(
context: Context,
appWidgetManager: AppWidgetManager,
Expand Down Expand Up @@ -189,9 +196,8 @@ class CardAnalysisWidget : AnalyticsWidgetProvider() {
Timber.d("AppWidgetIds to update: ${appWidgetIds.joinToString(", ")}")

for (appWidgetId in appWidgetIds) {
val widgetPreferences = CardAnalysisWidgetPreferences(context)
val deckId = widgetPreferences.getSelectedDeckIdFromPreferences(appWidgetId)
updateWidget(context, appWidgetManager, appWidgetId, deckId)
getDeckIdForWidget(context, appWidgetId)
updateWidget(context, appWidgetManager, appWidgetId)
}
}
}
Expand All @@ -204,21 +210,25 @@ class CardAnalysisWidget : AnalyticsWidgetProvider() {
) {
Timber.d("Performing widget update for appWidgetIds: %s", appWidgetIds)

val widgetPreferences = CardAnalysisWidgetPreferences(context)

for (widgetId in appWidgetIds) {
Timber.d("Updating widget with ID: $widgetId")
val selectedDeckId = widgetPreferences.getSelectedDeckIdFromPreferences(widgetId)

/**Explanation of behavior when selectedDeckId is empty
// Get the selected deck ID internally
val selectedDeckId = getDeckIdForWidget(context, widgetId)

/**
* Explanation of behavior when selectedDeckId is empty
* If selectedDeckId is empty, the widget will retain the previous deck.
* This behavior ensures that the widget does not display an empty view, which could be
* confusing to the user. Instead, it maintains the last known state until a new valid
* deck ID is provided. This approach prioritizes providing a consistent
* user experience over showing an empty or default state.
*/
Timber.d("Selected deck ID: $selectedDeckId for widget ID: $widgetId")
updateWidget(context, appWidgetManager, widgetId, selectedDeckId)

// Update the widget with the selected deck ID
updateWidget(context, appWidgetManager, widgetId)
// Set the recurring alarm for the widget
setRecurringAlarm(context, widgetId, CardAnalysisWidget::class.java)
}

Expand All @@ -244,19 +254,23 @@ class CardAnalysisWidget : AnalyticsWidgetProvider() {

Timber.d("Received ACTION_APPWIDGET_UPDATE with widget ID: $appWidgetId and selectedDeckId: $selectedDeckId")

if (appWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID && selectedDeckId != -1L) {
if (appWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID) {
Timber.d("Updating widget with ID: $appWidgetId")
// Wrap selectedDeckId into a LongArray
updateWidget(context, appWidgetManager, appWidgetId, selectedDeckId)

// Update the widget using the internally fetched deck ID
updateWidget(context, appWidgetManager, appWidgetId)

Timber.d("Widget update process completed for widget ID: $appWidgetId")
}
}
// This custom action is received to update a specific widget.
// It is triggered by the setRecurringAlarm method to refresh the widget's data periodically.
// Custom action to update a specific widget, triggered by the setRecurringAlarm method
ACTION_UPDATE_WIDGET -> {
val appWidgetId = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID)
if (appWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID) {
Timber.d("Received ACTION_UPDATE_WIDGET for widget ID: $appWidgetId")

// Update the widget using the internally fetched deck ID
updateWidget(context, AppWidgetManager.getInstance(context), appWidgetId)
}
}
AppWidgetManager.ACTION_APPWIDGET_DELETED -> {
Expand Down
18 changes: 9 additions & 9 deletions AnkiDroid/src/main/java/com/ichi2/widget/cardanalysis/CardAnalysisWidgetConfig.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,20 @@ import android.os.Bundle
import android.view.View
import android.widget.Button
import androidx.activity.OnBackPressedCallback
import androidx.annotation.StringRes
import androidx.core.view.isVisible
import androidx.lifecycle.lifecycleScope
import androidx.recyclerview.widget.LinearLayoutManager
import androidx.recyclerview.widget.RecyclerView
import com.google.android.material.floatingactionbutton.FloatingActionButton
import com.google.android.material.snackbar.Snackbar
import com.ichi2.anki.AnkiActivity
import com.ichi2.anki.DeckUtils.isCollectionEmpty
import com.ichi2.anki.R
import com.ichi2.anki.dialogs.DeckSelectionDialog
import com.ichi2.anki.dialogs.DeckSelectionDialog.DeckSelectionListener
import com.ichi2.anki.dialogs.DeckSelectionDialog.SelectableDeck
import com.ichi2.anki.dialogs.DiscardChangesDialog
import com.ichi2.anki.isCollectionEmpty
import com.ichi2.anki.showThemedToast
import com.ichi2.anki.snackbar.BaseSnackbarBuilderProvider
import com.ichi2.anki.snackbar.SnackbarBuilder
Expand All @@ -62,6 +63,7 @@ class CardAnalysisWidgetConfig : AnkiActivity(), DeckSelectionListener, BaseSnac
private var hasUnsavedChanges = false
private var isAdapterObserverRegistered = false
private lateinit var onBackPressedCallback: OnBackPressedCallback
private val EXTRA_SELECTED_DECK_IDS = "card_analysis_widget_selected_deck_ids"

override fun onCreate(savedInstanceState: Bundle?) {
if (showedActivityFailedScreen(savedInstanceState)) {
Expand Down Expand Up @@ -117,7 +119,7 @@ class CardAnalysisWidgetConfig : AnkiActivity(), DeckSelectionListener, BaseSnac
)
}

fun showSnackbar(messageResId: Int) {
fun showSnackbar(@StringRes messageResId: Int) {
showSnackbar(getString(messageResId))
}

Expand Down Expand Up @@ -291,17 +293,16 @@ class CardAnalysisWidgetConfig : AnkiActivity(), DeckSelectionListener, BaseSnac
deckAdapter.addDeck(deck)
updateViewVisibility()
updateFabVisibility()
hasUnsavedChanges = true
setUnsavedChanges(true)

// Save the selected deck immediately
saveSelectedDecksToPreferencesCardAnalysisWidget()
hasUnsavedChanges = false
setUnsavedChanges(false)

val selectedDeckId = cardAnalysisWidgetPreferences.getSelectedDeckIdFromPreferences(appWidgetId)
// Update the widget with the new selected deck ID
cardAnalysisWidgetPreferences.getSelectedDeckIdFromPreferences(appWidgetId)
val appWidgetManager = AppWidgetManager.getInstance(this)
CardAnalysisWidget.updateWidget(this, appWidgetManager, appWidgetId, selectedDeckId)
CardAnalysisWidget.updateWidget(this, appWidgetManager, appWidgetId)

val resultValue = Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
setResult(RESULT_OK, resultValue)
Expand All @@ -328,8 +329,7 @@ class CardAnalysisWidgetConfig : AnkiActivity(), DeckSelectionListener, BaseSnac
val updateIntent = Intent(this, CardAnalysisWidget::class.java).apply {
action = AppWidgetManager.ACTION_APPWIDGET_UPDATE
putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, intArrayOf(appWidgetId))

putExtra("card_analysis_widget_selected_deck_ids", selectedDeck)
putExtra(EXTRA_SELECTED_DECK_IDS, selectedDeck)
}

sendBroadcast(updateIntent)
Expand All @@ -347,7 +347,7 @@ class CardAnalysisWidgetConfig : AnkiActivity(), DeckSelectionListener, BaseSnac
return
}

context?.let { cardAnalysisWidgetPreferences.deleteDeckData(appWidgetId) }
cardAnalysisWidgetPreferences.deleteDeckData(appWidgetId)
}
}
}
Expand Down
8 changes: 2 additions & 6 deletions AnkiDroid/src/main/java/com/ichi2/widget/deckpicker/DeckPickerWidgetConfig.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ import androidx.recyclerview.widget.RecyclerView
import com.google.android.material.floatingactionbutton.FloatingActionButton
import com.google.android.material.snackbar.Snackbar
import com.ichi2.anki.AnkiActivity
import com.ichi2.anki.DeckUtils
import com.ichi2.anki.DeckUtils.isCollectionEmpty
import com.ichi2.anki.R
import com.ichi2.anki.dialogs.DeckSelectionDialog
import com.ichi2.anki.dialogs.DeckSelectionDialog.DeckSelectionListener
import com.ichi2.anki.dialogs.DeckSelectionDialog.SelectableDeck
import com.ichi2.anki.dialogs.DiscardChangesDialog
import com.ichi2.anki.isCollectionEmpty
import com.ichi2.anki.isDefaultDeckEmpty
import com.ichi2.anki.showThemedToast
import com.ichi2.anki.snackbar.BaseSnackbarBuilderProvider
import com.ichi2.anki.snackbar.SnackbarBuilder
Expand Down Expand Up @@ -280,10 +280,6 @@ class DeckPickerWidgetConfig : AnkiActivity(), DeckSelectionListener, BaseSnackb
}
}

private suspend fun isDefaultDeckEmpty(): Boolean {
return DeckUtils.isDefaultDeckEmpty()
}

/** Updates the view according to the saved preference for appWidgetId.*/
fun updateViewWithSavedPreferences() {
val selectedDeckIds = deckPickerWidgetPreferences.getSelectedDeckIdsFromPreferences(appWidgetId)
Expand Down
7 changes: 7 additions & 0 deletions AnkiDroid/src/test/java/com/ichi2/anki/widget/cardanalysis/CardAnalysisWidgetConfigTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import com.ichi2.widget.cardanalysis.CardAnalysisWidgetConfig
import com.ichi2.widget.cardanalysis.CardAnalysisWidgetPreferences
import org.hamcrest.MatcherAssert.assertThat
import org.hamcrest.Matchers.equalTo
import org.junit.After
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
Expand Down Expand Up @@ -66,6 +67,12 @@ class CardAnalysisWidgetConfigTest : RobolectricTest() {
activity.initializeUIComponents()
}

@After
override fun tearDown() {
super.tearDown()
activity.finish()
}

/**
* Tests the functionality of saving selected decks to preferences.
*
Expand Down

0 comments on commit 756ff6a

Please sign in to comment.