From 9b7a61471d342a2db4a2a6fe0681e748f15ca903 Mon Sep 17 00:00:00 2001 From: damoasda <46045854+damoasda@users.noreply.github.com> Date: Tue, 9 Jul 2019 08:55:46 +0200 Subject: Queue: Keep sorted #1556 --- .../core/preferences/UserPreferences.java | 32 ++++++++++- .../danoeh/antennapod/core/storage/DBWriter.java | 52 +++++++++-------- .../danoeh/antennapod/core/util/QueueSorter.java | 67 +++++++++++++++++++--- core/src/main/res/values-de/strings.xml | 9 +++ core/src/main/res/values/arrays.xml | 23 ++++++++ core/src/main/res/values/strings.xml | 7 +++ 6 files changed, 157 insertions(+), 33 deletions(-) (limited to 'core/src/main') diff --git a/core/src/main/java/de/danoeh/antennapod/core/preferences/UserPreferences.java b/core/src/main/java/de/danoeh/antennapod/core/preferences/UserPreferences.java index 60cec25d9..cfa217a12 100644 --- a/core/src/main/java/de/danoeh/antennapod/core/preferences/UserPreferences.java +++ b/core/src/main/java/de/danoeh/antennapod/core/preferences/UserPreferences.java @@ -54,6 +54,7 @@ public class UserPreferences { private static final String PREF_SHOW_DOWNLOAD_REPORT = "prefShowDownloadReport"; public static final String PREF_BACK_BUTTON_BEHAVIOR = "prefBackButtonBehavior"; private static final String PREF_BACK_BUTTON_GO_TO_PAGE = "prefBackButtonGoToPage"; + public static final String PREF_QUEUE_SORT_ORDER = "prefQueueSortOrder"; // Queue private static final String PREF_QUEUE_ADD_TO_FRONT = "prefQueueAddToFront"; @@ -506,7 +507,8 @@ public class UserPreferences { } public static boolean isQueueLocked() { - return prefs.getBoolean(PREF_QUEUE_LOCKED, false); + return prefs.getBoolean(PREF_QUEUE_LOCKED, false) + || !isQueueSortedManually(); } public static void setFastForwardSecs(int secs) { @@ -894,4 +896,32 @@ public class UserPreferences { public static boolean timeRespectsSpeed() { return prefs.getBoolean(PREF_TIME_RESPECTS_SPEED, false); } + + /** + * Supported episode queue sort orders. + * Use enum instead of integer to avoid mistakes at later maintenance changes. + */ + public enum QueueSortOrder { + MANUALLY, DATE_NEW_OLD, DATE_OLD_NEW, DURATION_SHORT_LONG, DURATION_LONG_SHORT, + EPISODE_TITLE_A_Z, EPISODE_TITLE_Z_A, FEED_TITLE_A_Z, FEED_TITLE_Z_A + } + + public static QueueSortOrder getQueueSortOrder() { + String sortOrderStr = prefs.getString(PREF_QUEUE_SORT_ORDER, "default"); + return parseQueueSortOrder(sortOrderStr); + } + + public static QueueSortOrder parseQueueSortOrder(String value) { + try { + return QueueSortOrder.valueOf(value); + } catch (IllegalArgumentException e) { + // default value + return QueueSortOrder.MANUALLY; + } + } + + public static boolean isQueueSortedManually() { + QueueSortOrder sortedOrder = getQueueSortOrder(); + return sortedOrder == QueueSortOrder.MANUALLY; + } } diff --git a/core/src/main/java/de/danoeh/antennapod/core/storage/DBWriter.java b/core/src/main/java/de/danoeh/antennapod/core/storage/DBWriter.java index c55acb6ef..515b463db 100644 --- a/core/src/main/java/de/danoeh/antennapod/core/storage/DBWriter.java +++ b/core/src/main/java/de/danoeh/antennapod/core/storage/DBWriter.java @@ -46,6 +46,7 @@ import de.danoeh.antennapod.core.service.playback.PlaybackService; import de.danoeh.antennapod.core.util.IntentUtils; import de.danoeh.antennapod.core.util.LongList; import de.danoeh.antennapod.core.util.Permutor; +import de.danoeh.antennapod.core.util.QueueSorter; import de.danoeh.antennapod.core.util.flattr.FlattrStatus; import de.danoeh.antennapod.core.util.flattr.FlattrThing; import de.danoeh.antennapod.core.util.flattr.SimpleFlattrThing; @@ -388,6 +389,7 @@ public class DBWriter { } } if (queueModified) { + applySortOrder(queue, events); adapter.setQueue(queue); for (QueueEvent event : events) { EventBus.getDefault().post(event); @@ -406,6 +408,29 @@ public class DBWriter { }); } + /** + * Sorts the queue depending on the configured sort order. If manual order is configured, the queue is not modified. + * + * @param queue The queue to be sorted. + * @param events Replaces the events by a single SORT event if the list has to be sorted automatically. + */ + private static void applySortOrder(List queue, List events) { + if (UserPreferences.isQueueSortedManually()) { + // automatic sort order is disabled, don't change anything + return; + } + + // Sort queue by configured sort order + UserPreferences.QueueSortOrder sortOrder = UserPreferences.getQueueSortOrder(); + QueueSorter.Rule sortRule = QueueSorter.queueSortOrder2Rule(sortOrder); + Permutor permutor = QueueSorter.getPermutor(sortRule); + permutor.reorder(queue); + + // Replace ADDED events by a single SORTED event + events.clear(); + events.add(QueueEvent.sorted(queue)); + } + /** * Removes all FeedItem objects from the queue. * @@ -964,31 +989,8 @@ public class DBWriter { } /** - * Sort the FeedItems in the queue with the given Comparator. - * @param comparator FeedItem comparator - * @param broadcastUpdate true if this operation should trigger a QueueUpdateBroadcast. This option should be set to - */ - public static Future sortQueue(final Comparator comparator, final boolean broadcastUpdate) { - return dbExec.submit(() -> { - final PodDBAdapter adapter = PodDBAdapter.getInstance(); - adapter.open(); - final List queue = DBReader.getQueue(adapter); - - if (queue != null) { - Collections.sort(queue, comparator); - adapter.setQueue(queue); - if (broadcastUpdate) { - EventBus.getDefault().post(QueueEvent.sorted(queue)); - } - } else { - Log.e(TAG, "sortQueue: Could not load queue"); - } - adapter.close(); - }); - } - - /** - * Similar to sortQueue, but allows more complex reordering by providing whole-queue context. + * Sort the FeedItems in the queue with the given Permutor. + * * @param permutor Encapsulates whole-Queue reordering logic. * @param broadcastUpdate true if this operation should trigger a * QueueUpdateBroadcast. This option should be set to false diff --git a/core/src/main/java/de/danoeh/antennapod/core/util/QueueSorter.java b/core/src/main/java/de/danoeh/antennapod/core/util/QueueSorter.java index 8680b2d2e..8bc377ffa 100644 --- a/core/src/main/java/de/danoeh/antennapod/core/util/QueueSorter.java +++ b/core/src/main/java/de/danoeh/antennapod/core/util/QueueSorter.java @@ -1,7 +1,5 @@ package de.danoeh.antennapod.core.util; -import android.content.Context; - import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; @@ -11,6 +9,7 @@ import java.util.Map; import de.danoeh.antennapod.core.feed.FeedItem; import de.danoeh.antennapod.core.feed.FeedMedia; +import de.danoeh.antennapod.core.preferences.UserPreferences; import de.danoeh.antennapod.core.storage.DBWriter; /** @@ -31,7 +30,30 @@ public class QueueSorter { SMART_SHUFFLE_DESC } - public static void sort(final Context context, final Rule rule, final boolean broadcastUpdate) { + /** + * Sorts the queue by the given rule and sends a broadcast update. + * + * @param rule Sort rule. + * @param broadcastUpdate Send broadcast update? + */ + public static void sort(Rule rule, boolean broadcastUpdate) { + Permutor permutor = getPermutor(rule); + if (permutor != null) { + DBWriter.reorderQueue(permutor, broadcastUpdate); + } + } + + /** + * Returns a Permutor that sorts a list appropriate to the given sort rule. + * + * @param rule Sort rule. + * @return Permutor that sorts a list appropriate to the given sort rule. null if the rule is unknown or null. + */ + public static Permutor getPermutor(Rule rule) { + if (rule == null) { + return null; + } + Comparator comparator = null; Permutor permutor = null; @@ -86,13 +108,44 @@ public class QueueSorter { case SMART_SHUFFLE_DESC: permutor = (queue) -> smartShuffle(queue, false); break; - default: } if (comparator != null) { - DBWriter.sortQueue(comparator, broadcastUpdate); - } else if (permutor != null) { - DBWriter.reorderQueue(permutor, broadcastUpdate); + final Comparator comparator2 = comparator; + permutor = (queue) -> Collections.sort(queue, comparator2); + } + return permutor; + } + + /** + * Converts a QueueSortOrder value to its corresponding Rule value. + * + * @param sortOrder Sort order. + * @return Rule value corresponding to the given sort order. null if the sort order is unknown or null. + */ + public static Rule queueSortOrder2Rule(UserPreferences.QueueSortOrder sortOrder) { + if (sortOrder == null) { + return null; + } + switch (sortOrder) { + case DATE_NEW_OLD: + return QueueSorter.Rule.DATE_DESC; + case DATE_OLD_NEW: + return QueueSorter.Rule.DATE_ASC; + case DURATION_SHORT_LONG: + return QueueSorter.Rule.DURATION_ASC; + case DURATION_LONG_SHORT: + return QueueSorter.Rule.DURATION_DESC; + case EPISODE_TITLE_A_Z: + return QueueSorter.Rule.EPISODE_TITLE_ASC; + case EPISODE_TITLE_Z_A: + return QueueSorter.Rule.EPISODE_TITLE_DESC; + case FEED_TITLE_A_Z: + return QueueSorter.Rule.FEED_TITLE_ASC; + case FEED_TITLE_Z_A: + return QueueSorter.Rule.FEED_TITLE_DESC; + default: + return null; } } diff --git a/core/src/main/res/values-de/strings.xml b/core/src/main/res/values-de/strings.xml index 8962daa00..7bc9368b5 100644 --- a/core/src/main/res/values-de/strings.xml +++ b/core/src/main/res/values-de/strings.xml @@ -285,6 +285,8 @@ Aufsteigend Absteigend Bitte bestätige, dass ALLE Episoden aus der Abspielliste entfernt werden sollen + Neu bis alt + Alt bis neu Flattr Anmeldung Drücke den Button unten, um den Authentifizierungsprozess zu starten. Du wirst zur Flattr-Anmeldeseite weitergeleitet. Hier wirst du gefragt, AntennaPod die Erlaubnis zu geben, Dinge zu flattrn. Nachdem du die Erlaubnis erteilt hast, kehrst du automatisch zu diesem Bildschirm zurück. @@ -414,6 +416,8 @@ Ändere die Reihenfolge deiner Abonnements Abonnement-Zähler einstellen Ändere die durch den Abonnementszähler angezeigten Informationen. Betrifft auch die Sortierung der Abonnements wenn \"Reihenfolge der Abonnements\" auf \"Zähler\" gesetzt ist. + Sortierung der Abspielliste einstellen + Ändere die Sortierreihenfolge der Episoden in der Abspielliste. Ändere das Aussehen von AntennaPod. Automatisches Herunterladen Konfiguriere das automatische Herunterladen von Episoden. @@ -686,6 +690,11 @@ Datum (alt \u2192 neu) Dauer (kurz \u2192 lang) Dauer (lang \u2192 kurz) + Episodentitel (A \u2192 Z) + Episodentitel (Z \u2192 A) + Podcasttitel (A \u2192 Z) + Podcasttitel (Z \u2192 A) + Manuell Gefällt dir AntennaPod? Wir würden uns freuen, wenn du dir kurz die Zeit nimmst, AntennaPod zu bewerten. diff --git a/core/src/main/res/values/arrays.xml b/core/src/main/res/values/arrays.xml index 39d1c0a94..d5df4f646 100644 --- a/core/src/main/res/values/arrays.xml +++ b/core/src/main/res/values/arrays.xml @@ -187,6 +187,29 @@ 3 + + @string/sort_manually + @string/sort_date_new_old + @string/sort_date_old_new + @string/sort_duration_short_long + @string/sort_duration_long_short + @string/sort_episode_title_a_z + @string/sort_episode_title_z_a + @string/sort_feed_title_a_z + @string/sort_feed_title_z_a + + + MANUALLY + DATE_NEW_OLD + DATE_OLD_NEW + DURATION_SHORT_LONG + DURATION_LONG_SHORT + EPISODE_TITLE_A_Z + EPISODE_TITLE_Z_A + FEED_TITLE_A_Z + FEED_TITLE_Z_A + + @string/drawer_feed_counter_new_unplayed @string/drawer_feed_counter_new diff --git a/core/src/main/res/values/strings.xml b/core/src/main/res/values/strings.xml index 2fbb65744..3d7cbfe10 100644 --- a/core/src/main/res/values/strings.xml +++ b/core/src/main/res/values/strings.xml @@ -438,6 +438,8 @@ Change the order of your subscriptions Set Subscription Counter Change the information displayed by the subscription counter. Also affects the sorting of subscriptions if \'Subscription Order\' is set to \'Counter\'. + Set Queue Sort Order + Change the sort order of the episodes in the queue. Change the appearance of AntennaPod. Automatic Download Configure the automatic download of episodes. @@ -735,6 +737,11 @@ Date (Old \u2192 New) Duration (Short \u2192 Long) Duration (Long \u2192 Short) + Episode title (A \u2192 Z) + Episode title (Z \u2192 A) + Podcast title (A \u2192 Z) + Podcast title (Z \u2192 A) + Manually Like AntennaPod? -- cgit v1.2.3