Skip to content

Commit

Permalink
refactor(Prefs): replace pref string keys with constants
Browse files Browse the repository at this point in the history
  • Loading branch information
@BrayanDSO @mikehardy
BrayanDSO authored and mikehardy committed Jan 26, 2025
1 parent 16f9315 commit fbd6dce
Show file tree
Hide file tree
Showing 2 changed files with 202 additions and 183 deletions.
286 changes: 148 additions & 138 deletions AnkiDroid/src/main/java/com/ichi2/anki/analytics/UsageAnalytics.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ object UsageAnalytics {
optIn = newValue
}
}
initializePrefKeys(context)
return sAnalytics
}

Expand Down Expand Up @@ -469,153 +470,162 @@ object UsageAnalytics {
val CHANGED_SETTING = "Changed setting"
}

// TODO use some kind of constants instead of hardcoded strings
@Suppress("ktlint:standard:discouraged-comment-location") // lots of work for little gain
val preferencesWhoseChangesShouldBeReported =
@VisibleForTesting
val reportablePrefKeys =
setOf(
// ******************************** General ************************************************
"reportErrorMode", // Error reporting mode
"pastePNG", // Paste clipboard images as PNG
"useCurrent", // Deck for new cards
"exitViaDoubleTapBack", // Press back twice to go back/exit
"anki_card_enable_external_context_menu", // ‘Anki Card’ Menu
"card_browser_enable_external_context_menu", // ‘Card Browser’ Menu
R.string.error_reporting_mode_key, // Error reporting mode
R.string.paste_png_key, // Paste clipboard images as PNG
R.string.deck_for_new_cards_key, // Deck for new cards
R.string.exit_via_double_tap_back_key, // Press back twice to go back/exit
R.string.anki_card_external_context_menu_key, // ‘Anki Card’ Menu
R.string.card_browser_external_context_menu_key, // ‘Card Browser’ Menu
// ******************************** Reviewing **********************************************
"dayOffset", // Start of next day
"learnCutoff", // Learn ahead limit
"timeLimit", // Timebox time limit
"keepScreenOn", // Disable screen timeout
"doubleTapTimeInterval", // Double tap time interval (milliseconds)
R.string.day_offset_preference, // Start of next day
R.string.learn_cutoff_preference, // Learn ahead limit
R.string.time_limit_preference, // Timebox time limit
R.string.keep_screen_on_preference, // Disable screen timeout
R.string.double_tap_time_interval_preference, // Double tap time interval (milliseconds)
// ******************************** Sync ***************************************************
"syncFetchMedia", // Fetch media on sync
"automaticSyncMode", // Automatic synchronization
"showSyncStatusBadge", // Display synchronization status
"allowMetered", // Allow sync on metered connections
"one_way_sync", // One-way sync
R.string.sync_fetch_media_key, // Fetch media on sync
R.string.automatic_sync_choice_key, // Automatic synchronization
R.string.sync_status_badge_key, // Display synchronization status
R.string.metered_sync_key, // Allow sync on metered connections
R.string.one_way_sync_key, // One-way sync
// ******************************** Backup *************************************************
"minutes_between_automatic_backups",
"daily_backups_to_keep",
"weekly_backups_to_keep",
"monthly_backups_to_keep",
R.string.pref_minutes_between_automatic_backups_key,
R.string.pref_daily_backups_to_keep_key,
R.string.pref_weekly_backups_to_keep_key,
R.string.pref_monthly_backups_to_keep_key,
// ******************************** Appearance *********************************************
"appTheme", // Theme
"dayTheme", // Day theme
"nightTheme", // Night theme
"deckPickerBackground", // Background image
"fullscreenMode", // Fullscreen mode
"centerVertically", // Center align
"showEstimates", // Show button time
"answerButtonPosition", // Answer buttons position
"showTopbar", // Show top bar
"showProgress", // Show remaining
"showETA", // Show ETA
"showAudioPlayButtons", // Show play buttons on cards with audio (reversed in collection: HIDE_AUDIO_PLAY_BUTTONS)
"card_browser_show_media_filenames", // Display filenames in card browser
"showDeckTitle", // Show deck title
R.string.app_theme_key, // Theme
R.string.day_theme_key, // Day theme
R.string.night_theme_key, // Night theme
R.string.pref_deck_picker_background_key, // Background image
R.string.fullscreen_mode_preference, // Fullscreen mode
R.string.center_vertically_preference, // Center align
R.string.show_estimates_preference, // Show button time
R.string.answer_buttons_position_preference, // Answer buttons position
R.string.show_topbar_preference, // Show top bar
R.string.show_progress_preference, // Show remaining
R.string.show_eta_preference, // Show ETA
R.string.show_audio_play_buttons_key, // Show play buttons on cards with audio (reversed in collection: HIDE_AUDIO_PLAY_BUTTONS)
R.string.pref_display_filenames_in_browser_key, // Display filenames in card browser
R.string.show_deck_title_key, // Show deck title
// ******************************** Controls *********************************************
"gestures", // Enable gestures
"gestureCornerTouch", // 9-point touch
"gestureFullScreenNavigationDrawer", // Full screen navigation drawer
"swipeSensitivity", // Swipe sensitivity
"binding_SHOW_ANSWER",
"binding_FLIP_OR_ANSWER_EASE1",
"binding_FLIP_OR_ANSWER_EASE2",
"binding_FLIP_OR_ANSWER_EASE3",
"binding_FLIP_OR_ANSWER_EASE4",
"binding_UNDO",
"binding_REDO",
"binding_EDIT",
"binding_MARK",
"binding_BURY_CARD",
"binding_SUSPEND_CARD",
"binding_DELETE",
"binding_PLAY_MEDIA",
"binding_EXIT",
"binding_BURY_NOTE",
"binding_SUSPEND_NOTE",
"binding_TOGGLE_FLAG_RED",
"binding_TOGGLE_FLAG_ORANGE",
"binding_TOGGLE_FLAG_GREEN",
"binding_TOGGLE_FLAG_BLUE",
"binding_TOGGLE_FLAG_PINK",
"binding_TOGGLE_FLAG_TURQUOISE",
"binding_TOGGLE_FLAG_PURPLE",
"binding_UNSET_FLAG",
"binding_PAGE_UP",
"binding_PAGE_DOWN",
"binding_TAG",
"binding_CARD_INFO",
"binding_ABORT_AND_SYNC",
"binding_RECORD_VOICE",
"binding_REPLAY_VOICE",
"binding_SAVE_VOICE",
"binding_TOGGLE_WHITEBOARD",
"binding_CLEAR_WHITEBOARD",
"binding_CHANGE_WHITEBOARD_PEN_COLOR",
"binding_TOGGLE_AUTO_ADVANCE",
"binding_SHOW_HINT",
"binding_SHOW_ALL_HINTS",
"binding_ADD_NOTE",
"binding_RESCHEDULE_NOTE",
"binding_USER_ACTION_1",
"binding_USER_ACTION_2",
"binding_USER_ACTION_3",
"binding_USER_ACTION_4",
"binding_USER_ACTION_5",
"binding_USER_ACTION_6",
"binding_USER_ACTION_7",
"binding_USER_ACTION_8",
"binding_USER_ACTION_9",
R.string.gestures_preference, // Enable gestures
R.string.gestures_corner_touch_preference, // 9-point touch
R.string.nav_drawer_gesture_key, // Full screen navigation drawer
R.string.pref_swipe_sensitivity_key, // Swipe sensitivity
R.string.show_answer_command_key,
R.string.answer_again_command_key,
R.string.answer_hard_command_key,
R.string.answer_good_command_key,
R.string.answer_easy_command_key,
R.string.undo_command_key,
R.string.redo_command_key,
R.string.edit_command_key,
R.string.mark_command_key,
R.string.bury_card_command_key,
R.string.suspend_card_command_key,
R.string.delete_command_key,
R.string.play_media_command_key,
R.string.abort_command_key,
R.string.bury_note_command_key,
R.string.suspend_note_command_key,
R.string.flag_red_command_key,
R.string.flag_orange_command_key,
R.string.flag_green_command_key,
R.string.flag_blue_command_key,
R.string.flag_pink_command_key,
R.string.flag_turquoise_command_key,
R.string.flag_purple_command_key,
R.string.remove_flag_command_key,
R.string.page_up_command_key,
R.string.page_down_command_key,
R.string.tag_command_key,
R.string.card_info_command_key,
R.string.abort_and_sync_command_key,
R.string.record_voice_command_key,
R.string.replay_voice_command_key,
R.string.save_voice_command_key,
R.string.toggle_whiteboard_command_key,
R.string.clear_whiteboard_command_key,
R.string.change_whiteboard_pen_color_command_key,
R.string.toggle_auto_advance_command_key,
R.string.show_hint_command_key,
R.string.show_all_hints_command_key,
R.string.add_note_command_key,
R.string.reschedule_command_key,
R.string.user_action_1_key,
R.string.user_action_2_key,
R.string.user_action_3_key,
R.string.user_action_4_key,
R.string.user_action_5_key,
R.string.user_action_6_key,
R.string.user_action_7_key,
R.string.user_action_8_key,
R.string.user_action_9_key,
// ******************************** Accessibility ******************************************
"cardZoom",
"imageZoom",
"answerButtonSize",
"showLargeAnswerButtons",
"relativeCardBrowserFontSize",
"showCardAnswerButtonTime",
R.string.card_zoom_preference,
R.string.image_zoom_preference,
R.string.answer_button_size_preference,
R.string.show_large_answer_buttons_preference,
R.string.pref_card_browser_font_scale_key,
R.string.pref_card_minimal_click_time,
// ******************************** Advanced ***********************************************
"deckPath", // AnkiDroid directory
"double_scrolling", // Double scrolling
"softwareRender", // Disable card hardware render
"safeDisplay", // Safe display mode
"useInputTag", // Type answer into the card
"disableExtendedTextUi", // Disable Single-Field Edit Mode
"noteEditorNewlineReplace", // Replace newlines with HTML
"autoFocusTypeInAnswer", // Focus ‘type in answer’
"mediaImportAllowAllFiles", // Allow all files in media imports
"providerEnabled", // Enable AnkiDroid API
R.string.pref_ankidroid_directory_key, // AnkiDroid directory
R.string.double_scrolling_gap_key, // Double scrolling
R.string.disable_hardware_render_key, // Disable card hardware render
R.string.safe_display_key, // Safe display mode
R.string.use_input_tag_key, // Type answer into the card
R.string.disable_single_field_edit_key, // Disable Single-Field Edit Mode
R.string.note_editor_newline_replace_key, // Replace newlines with HTML
R.string.type_in_answer_focus_key, // Focus ‘type in answer’
R.string.media_import_allow_all_files_key, // Allow all files in media imports
R.string.enable_api_key, // Enable AnkiDroid API
// ******************************** App bar buttons ****************************************
"reset_custom_buttons",
"customButtonUndo",
"customButtonRedo",
"customButtonScheduleCard",
"customButtonFlag",
"customButtonEditCard",
"customButtonTags",
"customButtonAddCard",
"customButtonReplay",
"customButtonCardInfo",
"customButtonSelectTts",
"customButtonDeckOptions",
"customButtonMarkCard",
"customButtonToggleMicToolBar",
"customButtonBury",
"customButtonSuspend",
"customButtonDelete",
"customButtonEnableWhiteboard",
"customButtonToggleStylus",
"customButtonSaveWhiteboard",
"customButtonWhiteboardPenColor",
"customButtonShowHideWhiteboard",
"customButtonClearWhiteboard",
"customButtonUserAction1",
"customButtonUserAction2",
"customButtonUserAction3",
"customButtonUserAction4",
"customButtonUserAction5",
"customButtonUserAction6",
"customButtonUserAction7",
"customButtonUserAction8",
"customButtonUserAction9",
R.string.reset_custom_buttons_key,
R.string.custom_button_undo_key,
R.string.custom_button_redo_key,
R.string.custom_button_schedule_card_key,
R.string.custom_button_flag_key,
R.string.custom_button_edit_card_key,
R.string.custom_button_tags_key,
R.string.custom_button_add_card_key,
R.string.custom_button_replay_key,
R.string.custom_button_card_info_key,
R.string.custom_button_select_tts_key,
R.string.custom_button_deck_options_key,
R.string.custom_button_mark_card_key,
R.string.custom_button_toggle_mic_toolbar_key,
R.string.custom_button_bury_key,
R.string.custom_button_suspend_key,
R.string.custom_button_delete_key,
R.string.custom_button_enable_whiteboard_key,
R.string.custom_button_toggle_stylus_key,
R.string.custom_button_save_whiteboard_key,
R.string.custom_button_whiteboard_pen_color_key,
R.string.custom_button_show_hide_whiteboard_key,
R.string.custom_button_clear_whiteboard_key,
R.string.custom_button_user_action_1_key,
R.string.custom_button_user_action_2_key,
R.string.custom_button_user_action_3_key,
R.string.custom_button_user_action_4_key,
R.string.custom_button_user_action_5_key,
R.string.custom_button_user_action_6_key,
R.string.custom_button_user_action_7_key,
R.string.custom_button_user_action_8_key,
R.string.custom_button_user_action_9_key,
)

lateinit var preferencesWhoseChangesShouldBeReported: Set<String>

@Suppress("ktlint:standard:discouraged-comment-location") // lots of work for little gain
private fun initializePrefKeys(context: Context) {
preferencesWhoseChangesShouldBeReported =
reportablePrefKeys.mapTo(mutableSetOf()) { resId ->
context.getString(resId)
}
}
}
Loading

0 comments on commit fbd6dce

Please sign in to comment.