diff options
Diffstat (limited to 'core/src/main/java')
3 files changed, 118 insertions, 33 deletions
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 8f5f5ae1e..9348ca807 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"; @@ -491,7 +492,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) { @@ -866,4 +868,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 49fbdcbfd..2de811788 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 @@ -44,6 +44,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; /** * Provides methods for writing data to AntennaPod's database. @@ -383,6 +384,7 @@ public class DBWriter { } } if (queueModified) { + applySortOrder(queue, events); adapter.setQueue(queue); for (QueueEvent event : events) { EventBus.getDefault().post(event); @@ -402,6 +404,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<FeedItem> queue, List<QueueEvent> 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<FeedItem> 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. * */ @@ -850,31 +875,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<FeedItem> comparator, final boolean broadcastUpdate) { - return dbExec.submit(() -> { - final PodDBAdapter adapter = PodDBAdapter.getInstance(); - adapter.open(); - final List<FeedItem> 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 <code>true</code> if this operation should trigger a * QueueUpdateBroadcast. This option should be set to <code>false</code> 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<FeedItem> 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. <code>null</code> if the rule is unknown or <code>null</code>. + */ + public static Permutor<FeedItem> getPermutor(Rule rule) { + if (rule == null) { + return null; + } + Comparator<FeedItem> comparator = null; Permutor<FeedItem> 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<FeedItem> 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. <code>null</code> if the sort order is unknown or <code>null</code>. + */ + 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; } } |