Add time-based statistics filter (#5734)

5 files changed, 163 insertions, 88 deletions

diff --git a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/DownloadStatisticsFragment.java b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/DownloadStatisticsFragment.java
index ffaaedec8..f8f489fc4 100644
--- a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/DownloadStatisticsFragment.java
+++ b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/DownloadStatisticsFragment.java
@@ -3,6 +3,7 @@ package de.danoeh.antennapod.fragment.preferences;
 import android.os.Bundle;
 import android.util.Log;
 import android.view.LayoutInflater;
+import android.view.Menu;
 import android.view.View;
 import android.view.ViewGroup;
 import android.widget.ProgressBar;
@@ -16,14 +17,12 @@ import androidx.recyclerview.widget.RecyclerView;
 import de.danoeh.antennapod.R;
 import de.danoeh.antennapod.adapter.DownloadStatisticsListAdapter;
 import de.danoeh.antennapod.core.storage.DBReader;
-import de.danoeh.antennapod.core.storage.StatisticsItem;
 import io.reactivex.Observable;
 import io.reactivex.android.schedulers.AndroidSchedulers;
 import io.reactivex.disposables.Disposable;
 import io.reactivex.schedulers.Schedulers;
 
 import java.util.Collections;
-import java.util.List;
 
 /**
  * Displays the 'download statistics' screen
@@ -38,7 +37,8 @@ public class DownloadStatisticsFragment extends Fragment {
 
     @Nullable
     @Override
-    public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
+    public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container,
+                             @Nullable Bundle savedInstanceState) {
         View root = inflater.inflate(R.layout.statistics_activity, container, false);
         downloadStatisticsList = root.findViewById(R.id.statistics_list);
         progressBar = root.findViewById(R.id.progressBar);
@@ -54,6 +54,13 @@ public class DownloadStatisticsFragment extends Fragment {
         refreshDownloadStatistics();
     }
 
+    @Override
+    public void onPrepareOptionsMenu(@NonNull Menu menu) {
+        super.onPrepareOptionsMenu(menu);
+        menu.findItem(R.id.statistics_reset).setVisible(false);
+        menu.findItem(R.id.statistics_filter).setVisible(false);
+    }
+
     private void refreshDownloadStatistics() {
         progressBar.setVisibility(View.VISIBLE);
         downloadStatisticsList.setVisibility(View.GONE);
@@ -67,15 +74,16 @@ public class DownloadStatisticsFragment extends Fragment {
 
         disposable =
                 Observable.fromCallable(() -> {
-                    List<StatisticsItem> statisticsData = DBReader.getStatistics();
-                    Collections.sort(statisticsData, (item1, item2) ->
+                    // Filters do not matter here
+                    DBReader.StatisticsResult statisticsData = DBReader.getStatistics(false, 0, Long.MAX_VALUE);
+                    Collections.sort(statisticsData.feedTime, (item1, item2) ->
                             Long.compare(item2.totalDownloadSize, item1.totalDownloadSize));
                     return statisticsData;
                 })
                 .subscribeOn(Schedulers.io())
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(result -> {
-                    listAdapter.update(result);
+                    listAdapter.update(result.feedTime);
                     progressBar.setVisibility(View.GONE);
                     downloadStatisticsList.setVisibility(View.VISIBLE);
                 }, error -> Log.e(TAG, Log.getStackTraceString(error)));
diff --git a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/ImportExportPreferencesFragment.java b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/ImportExportPreferencesFragment.java
index 5156de432..5bbc8f0a0 100644
--- a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/ImportExportPreferencesFragment.java
+++ b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/ImportExportPreferencesFragment.java
@@ -31,7 +31,6 @@ import de.danoeh.antennapod.core.export.ExportWriter;
 import de.danoeh.antennapod.core.export.favorites.FavoritesWriter;
 import de.danoeh.antennapod.core.export.html.HtmlWriter;
 import de.danoeh.antennapod.core.export.opml.OpmlWriter;
-import de.danoeh.antennapod.core.preferences.UserPreferences;
 import de.danoeh.antennapod.core.storage.DatabaseExporter;
 import io.reactivex.Completable;
 import io.reactivex.Observable;
@@ -263,7 +262,6 @@ public class ImportExportPreferencesFragment extends PreferenceFragmentCompat {
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(() -> {
                     showDatabaseImportSuccessDialog();
-                    UserPreferences.unsetUsageCountingDate();
                     progressDialog.dismiss();
                 }, this::showExportErrorDialog);
     }
diff --git a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/MainPreferencesFragment.java b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/MainPreferencesFragment.java
index 891d3737b..e2c5036df 100644
--- a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/MainPreferencesFragment.java
+++ b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/MainPreferencesFragment.java
@@ -29,7 +29,6 @@ public class MainPreferencesFragment extends PreferenceFragmentCompat {
     private static final String PREF_VIEW_FORUM = "prefViewForum";
     private static final String PREF_SEND_BUG_REPORT = "prefSendBugReport";
     private static final String PREF_CATEGORY_PROJECT = "project";
-    private static final String STATISTICS = "statistics";
     private static final String PREF_ABOUT = "prefAbout";
     private static final String PREF_NOTIFICATION = "notifications";
     private static final String PREF_CONTRIBUTE = "prefContribute";
@@ -106,14 +105,6 @@ public class MainPreferencesFragment extends PreferenceFragmentCompat {
                     return true;
                 }
         );
-        findPreference(STATISTICS).setOnPreferenceClickListener(
-                preference -> {
-                    getParentFragmentManager().beginTransaction()
-                            .replace(R.id.settingsContainer, new StatisticsFragment())
-                            .addToBackStack(getString(R.string.statistics_label)).commit();
-                    return true;
-                }
-        );
         findPreference(PREF_DOCUMENTATION).setOnPreferenceClickListener(preference -> {
             IntentUtils.openInBrowser(getContext(), "https://antennapod.org/documentation/");
             return true;
diff --git a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/PlaybackStatisticsFragment.java b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/PlaybackStatisticsFragment.java
index ba6164212..31c96a2ff 100644
--- a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/PlaybackStatisticsFragment.java
+++ b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/PlaybackStatisticsFragment.java
@@ -7,16 +7,16 @@ import android.os.Bundle;
 import android.util.Log;
 import android.view.LayoutInflater;
 import android.view.Menu;
-import android.view.MenuInflater;
 import android.view.MenuItem;
 import android.view.View;
 import android.view.ViewGroup;
+import android.widget.ArrayAdapter;
 import android.widget.ProgressBar;
-import android.widget.RadioButton;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.appcompat.app.AlertDialog;
+import androidx.core.util.Pair;
 import androidx.fragment.app.Fragment;
 import androidx.recyclerview.widget.LinearLayoutManager;
 import androidx.recyclerview.widget.RecyclerView;
@@ -24,18 +24,21 @@ import androidx.recyclerview.widget.RecyclerView;
 import de.danoeh.antennapod.R;
 import de.danoeh.antennapod.adapter.PlaybackStatisticsListAdapter;
 import de.danoeh.antennapod.core.dialog.ConfirmationDialog;
-import de.danoeh.antennapod.core.preferences.UserPreferences;
 import de.danoeh.antennapod.core.storage.DBReader;
 import de.danoeh.antennapod.core.storage.DBWriter;
-import de.danoeh.antennapod.core.storage.StatisticsItem;
+import de.danoeh.antennapod.databinding.StatisticsFilterDialogBinding;
 import io.reactivex.Completable;
 import io.reactivex.Observable;
 import io.reactivex.android.schedulers.AndroidSchedulers;
 import io.reactivex.disposables.Disposable;
 import io.reactivex.schedulers.Schedulers;
 
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.Calendar;
 import java.util.Collections;
-import java.util.List;
+import java.util.Date;
+import java.util.Locale;
 
 /**
  * Displays the 'playback statistics' screen
@@ -43,20 +46,27 @@ import java.util.List;
 public class PlaybackStatisticsFragment extends Fragment {
     private static final String TAG = PlaybackStatisticsFragment.class.getSimpleName();
     private static final String PREF_NAME = "StatisticsActivityPrefs";
-    private static final String PREF_COUNT_ALL = "countAll";
+    private static final String PREF_INCLUDE_MARKED_PLAYED = "countAll";
+    private static final String PREF_FILTER_FROM = "filterFrom";
+    private static final String PREF_FILTER_TO = "filterTo";
 
     private Disposable disposable;
     private RecyclerView feedStatisticsList;
     private ProgressBar progressBar;
     private PlaybackStatisticsListAdapter listAdapter;
-    private boolean countAll = false;
+    private boolean includeMarkedAsPlayed = false;
+    private long timeFilterFrom = 0;
+    private long timeFilterTo = Long.MAX_VALUE;
     private SharedPreferences prefs;
+    private DBReader.StatisticsResult statisticsResult;
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         prefs = getContext().getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE);
-        countAll = prefs.getBoolean(PREF_COUNT_ALL, false);
+        includeMarkedAsPlayed = prefs.getBoolean(PREF_INCLUDE_MARKED_PLAYED, false);
+        timeFilterFrom = prefs.getLong(PREF_FILTER_FROM, 0);
+        timeFilterTo = prefs.getLong(PREF_FILTER_TO, Long.MAX_VALUE);
         setHasOptionsMenu(true);
     }
 
@@ -68,7 +78,6 @@ public class PlaybackStatisticsFragment extends Fragment {
         feedStatisticsList = root.findViewById(R.id.statistics_list);
         progressBar = root.findViewById(R.id.progressBar);
         listAdapter = new PlaybackStatisticsListAdapter(this);
-        listAdapter.setCountAll(countAll);
         feedStatisticsList.setLayoutManager(new LinearLayoutManager(getContext()));
         feedStatisticsList.setAdapter(listAdapter);
         return root;
@@ -89,62 +98,129 @@ public class PlaybackStatisticsFragment extends Fragment {
     }
 
     @Override
-    public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
-        inflater.inflate(R.menu.statistics, menu);
-        menu.findItem(R.id.statistics_reset).setEnabled(!countAll);
+    public void onPrepareOptionsMenu(@NonNull Menu menu) {
+        super.onPrepareOptionsMenu(menu);
+        menu.findItem(R.id.statistics_reset).setVisible(true);
+        menu.findItem(R.id.statistics_filter).setVisible(true);
     }
 
     @Override
     public boolean onOptionsItemSelected(MenuItem item) {
-        if (item.getItemId() == R.id.statistics_mode) {
-            selectStatisticsMode();
+        if (item.getItemId() == R.id.statistics_filter) {
+            selectStatisticsFilter();
             return true;
-        }
-        if (item.getItemId() == R.id.statistics_reset) {
+        } else if (item.getItemId() == R.id.statistics_reset) {
             confirmResetStatistics();
             return true;
         }
         return super.onOptionsItemSelected(item);
     }
 
-    private void selectStatisticsMode() {
-        View contentView = View.inflate(getContext(), R.layout.statistics_mode_select_dialog, null);
+    private void selectStatisticsFilter() {
+        if (statisticsResult == null) {
+            return;
+        }
+        StatisticsFilterDialogBinding dialogBinding = StatisticsFilterDialogBinding.inflate(getLayoutInflater());
         AlertDialog.Builder builder = new AlertDialog.Builder(getContext());
-        builder.setView(contentView);
-        builder.setTitle(R.string.statistics_mode);
+        builder.setView(dialogBinding.getRoot());
+        builder.setTitle(R.string.filter);
+        dialogBinding.includeMarkedCheckbox.setOnCheckedChangeListener((compoundButton, checked) -> {
+            dialogBinding.timeToSpinner.setEnabled(!checked);
+            dialogBinding.timeFromSpinner.setEnabled(!checked);
+            dialogBinding.lastYearButton.setEnabled(!checked);
+            dialogBinding.allTimeButton.setEnabled(!checked);
+            dialogBinding.dateSelectionContainer.setAlpha(checked ? 0.5f : 1f);
+        });
+        dialogBinding.includeMarkedCheckbox.setChecked(includeMarkedAsPlayed);
+
+        Pair<String[], Long[]> filterDates = makeMonthlyList(statisticsResult.oldestDate);
+
+        ArrayAdapter<String> adapterFrom = new ArrayAdapter<>(getContext(),
+                android.R.layout.simple_spinner_item, filterDates.first);
+        adapterFrom.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
+        dialogBinding.timeFromSpinner.setAdapter(adapterFrom);
+        for (int i = 0; i < filterDates.second.length; i++) {
+            if (filterDates.second[i] >= timeFilterFrom) {
+                dialogBinding.timeFromSpinner.setSelection(i);
+                break;
+            }
+        }
 
-        if (countAll) {
-            ((RadioButton) contentView.findViewById(R.id.statistics_mode_count_all)).setChecked(true);
-        } else {
-            ((RadioButton) contentView.findViewById(R.id.statistics_mode_normal)).setChecked(true);
+        ArrayAdapter<String> adapterTo = new ArrayAdapter<>(getContext(),
+                android.R.layout.simple_spinner_item, filterDates.first);
+        adapterTo.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
+        dialogBinding.timeToSpinner.setAdapter(adapterTo);
+        for (int i = 0; i < filterDates.second.length; i++) {
+            if (filterDates.second[i] >= timeFilterTo) {
+                dialogBinding.timeToSpinner.setSelection(i);
+                break;
+            }
         }
 
+        dialogBinding.allTimeButton.setOnClickListener(v -> {
+            dialogBinding.timeFromSpinner.setSelection(0);
+            dialogBinding.timeToSpinner.setSelection(filterDates.first.length - 1);
+        });
+        dialogBinding.lastYearButton.setOnClickListener(v -> {
+            dialogBinding.timeFromSpinner.setSelection(Math.max(0, filterDates.first.length - 14));
+            dialogBinding.timeToSpinner.setSelection(filterDates.first.length - 2);
+        });
+
         builder.setPositiveButton(android.R.string.ok, (dialog, which) -> {
-            countAll = ((RadioButton) contentView.findViewById(R.id.statistics_mode_count_all)).isChecked();
-            listAdapter.setCountAll(countAll);
-            prefs.edit().putBoolean(PREF_COUNT_ALL, countAll).apply();
+            includeMarkedAsPlayed = dialogBinding.includeMarkedCheckbox.isChecked();
+            if (includeMarkedAsPlayed) {
+                // We do not know the date at which something was marked as played, so filtering does not make sense
+                timeFilterFrom = 0;
+                timeFilterTo = Long.MAX_VALUE;
+            } else {
+                timeFilterFrom = filterDates.second[dialogBinding.timeFromSpinner.getSelectedItemPosition()];
+                timeFilterTo = filterDates.second[dialogBinding.timeToSpinner.getSelectedItemPosition()];
+            }
+            prefs.edit()
+                    .putBoolean(PREF_INCLUDE_MARKED_PLAYED, includeMarkedAsPlayed)
+                    .putLong(PREF_FILTER_FROM, timeFilterFrom)
+                    .putLong(PREF_FILTER_TO, timeFilterTo)
+                    .apply();
             refreshStatistics();
-            getActivity().invalidateOptionsMenu();
         });
-
         builder.show();
     }
 
-    private void confirmResetStatistics() {
-        if (!countAll) {
-            ConfirmationDialog conDialog = new ConfirmationDialog(
-                    getActivity(),
-                    R.string.statistics_reset_data,
-                    R.string.statistics_reset_data_msg) {
-
-                @Override
-                public void onConfirmButtonPressed(DialogInterface dialog) {
-                    dialog.dismiss();
-                    doResetStatistics();
-                }
-            };
-            conDialog.createNewDialog().show();
+    private Pair<String[], Long[]> makeMonthlyList(long oldestDate) {
+        Calendar date = Calendar.getInstance();
+        date.setTimeInMillis(oldestDate);
+        date.set(Calendar.DAY_OF_MONTH, 1);
+        ArrayList<String> names = new ArrayList<>();
+        ArrayList<Long> timestamps = new ArrayList<>();
+        SimpleDateFormat dateFormat = new SimpleDateFormat("MMM yyyy", Locale.getDefault());
+        while (date.getTimeInMillis() < System.currentTimeMillis()) {
+            names.add(dateFormat.format(new Date(date.getTimeInMillis())));
+            timestamps.add(date.getTimeInMillis());
+            if (date.get(Calendar.MONTH) == Calendar.DECEMBER) {
+                date.set(Calendar.MONTH, Calendar.JANUARY);
+                date.set(Calendar.YEAR, date.get(Calendar.YEAR) + 1);
+            } else {
+                date.set(Calendar.MONTH, date.get(Calendar.MONTH) + 1);
+            }
         }
+        names.add(getString(R.string.statistics_today));
+        timestamps.add(Long.MAX_VALUE);
+        return new Pair<>(names.toArray(new String[0]), timestamps.toArray(new Long[0]));
+    }
+
+    private void confirmResetStatistics() {
+        ConfirmationDialog conDialog = new ConfirmationDialog(
+                getActivity(),
+                R.string.statistics_reset_data,
+                R.string.statistics_reset_data_msg) {
+
+            @Override
+            public void onConfirmButtonPressed(DialogInterface dialog) {
+                dialog.dismiss();
+                doResetStatistics();
+            }
+        };
+        conDialog.createNewDialog().show();
     }
 
     private void doResetStatistics() {
@@ -154,13 +230,19 @@ public class PlaybackStatisticsFragment extends Fragment {
             disposable.dispose();
         }
 
+        includeMarkedAsPlayed = false;
+        timeFilterFrom = 0;
+        timeFilterTo = Long.MAX_VALUE;
+        prefs.edit()
+                .putBoolean(PREF_INCLUDE_MARKED_PLAYED, includeMarkedAsPlayed)
+                .putLong(PREF_FILTER_FROM, timeFilterFrom)
+                .putLong(PREF_FILTER_TO, timeFilterTo)
+                .apply();
+
         disposable = Completable.fromFuture(DBWriter.resetStatistics())
                 .subscribeOn(Schedulers.io())
                 .observeOn(AndroidSchedulers.mainThread())
-                .subscribe(() -> {
-                    refreshStatistics();
-                    UserPreferences.resetUsageCountingDate();
-                }, error -> Log.e(TAG, Log.getStackTraceString(error)));
+                .subscribe(this::refreshStatistics, error -> Log.e(TAG, Log.getStackTraceString(error)));
     }
 
     private void refreshStatistics() {
@@ -173,25 +255,25 @@ public class PlaybackStatisticsFragment extends Fragment {
         if (disposable != null) {
             disposable.dispose();
         }
-        disposable = Observable.fromCallable(this::fetchStatistics)
+        disposable = Observable.fromCallable(
+                () -> {
+                    DBReader.StatisticsResult statisticsData = DBReader.getStatistics(
+                            includeMarkedAsPlayed, timeFilterFrom, timeFilterTo);
+                    Collections.sort(statisticsData.feedTime, (item1, item2) ->
+                            Long.compare(item2.timePlayed, item1.timePlayed));
+                    return statisticsData;
+                })
                 .subscribeOn(Schedulers.io())
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(result -> {
-                    listAdapter.update(result);
+                    statisticsResult = result;
+                    // When "from" is "today", set it to today
+                    listAdapter.setTimeFilter(includeMarkedAsPlayed, Math.max(
+                                Math.min(timeFilterFrom, System.currentTimeMillis()), result.oldestDate),
+                            Math.min(timeFilterTo, System.currentTimeMillis()));
+                    listAdapter.update(result.feedTime);
                     progressBar.setVisibility(View.GONE);
                     feedStatisticsList.setVisibility(View.VISIBLE);
                 }, error -> Log.e(TAG, Log.getStackTraceString(error)));
     }
-
-    private List<StatisticsItem> fetchStatistics() {
-        List<StatisticsItem> statisticsData = DBReader.getStatistics();
-        if (countAll) {
-            Collections.sort(statisticsData, (item1, item2) ->
-                    Long.compare(item2.timePlayedCountAll, item1.timePlayedCountAll));
-        } else {
-            Collections.sort(statisticsData, (item1, item2) ->
-                    Long.compare(item2.timePlayed, item1.timePlayed));
-        }
-        return statisticsData;
-    }
 }
diff --git a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/StatisticsFragment.java b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/StatisticsFragment.java
index 4110662a1..5a280ac81 100644
--- a/app/src/main/java/de/danoeh/antennapod/fragment/preferences/StatisticsFragment.java
+++ b/app/src/main/java/de/danoeh/antennapod/fragment/preferences/StatisticsFragment.java
@@ -16,11 +16,12 @@ import com.google.android.material.tabs.TabLayoutMediator;
 
 import de.danoeh.antennapod.R;
 import de.danoeh.antennapod.activity.PreferenceActivity;
+import de.danoeh.antennapod.fragment.PagedToolbarFragment;
 
 /**
  * Displays the 'statistics' screen
  */
-public class StatisticsFragment extends Fragment {
+public class StatisticsFragment extends PagedToolbarFragment {
 
     public static final String TAG = "StatisticsFragment";
 
@@ -28,7 +29,6 @@ public class StatisticsFragment extends Fragment {
     private static final int POS_SPACE_TAKEN = 1;
     private static final int TOTAL_COUNT = 2;
 
-
     private TabLayout tabLayout;
     private ViewPager2 viewPager;
     private Toolbar toolbar;
@@ -42,9 +42,13 @@ public class StatisticsFragment extends Fragment {
         View rootView = inflater.inflate(R.layout.pager_fragment, container, false);
         viewPager = rootView.findViewById(R.id.viewpager);
         toolbar = rootView.findViewById(R.id.toolbar);
+        toolbar.setTitle(getString(R.string.statistics_label));
+        toolbar.inflateMenu(R.menu.statistics);
+        toolbar.setNavigationOnClickListener(v -> getParentFragmentManager().popBackStack());
         viewPager.setAdapter(new StatisticsPagerAdapter(this));
         // Give the TabLayout the ViewPager
         tabLayout = rootView.findViewById(R.id.sliding_tabs);
+        super.setupPagedToolbar(toolbar, viewPager);
         new TabLayoutMediator(tabLayout, viewPager, (tab, position) -> {
             switch (position) {
                 case POS_LISTENED_HOURS:
@@ -57,14 +61,6 @@ public class StatisticsFragment extends Fragment {
                     break;
             }
         }).attach();
-
-        if (getActivity().getClass() == PreferenceActivity.class) {
-            rootView.findViewById(R.id.toolbar).setVisibility(View.GONE);
-        } else {
-            toolbar.setTitle(getString(R.string.statistics_label));
-            toolbar.setNavigationOnClickListener(v -> getParentFragmentManager().popBackStack());
-        }
-
         return rootView;
     }