Merge pull request #3371 from mauriciocolli/feed-hide-played-items

Add ability to hide played items in a feed

app/src/main/java/org/schabi/newpipe/database/feed/dao/FeedDAO.kt

@@ -9,7 +9,8 @@ import androidx.room.Update
 import io.reactivex.rxjava3.core.Flowable
 import org.schabi.newpipe.database.feed.model.FeedEntity
 import org.schabi.newpipe.database.feed.model.FeedLastUpdatedEntity
-import org.schabi.newpipe.database.stream.model.StreamEntity
+import org.schabi.newpipe.database.stream.StreamWithState
+import org.schabi.newpipe.database.stream.model.StreamStateEntity
 import org.schabi.newpipe.database.subscription.SubscriptionEntity
 import java.time.OffsetDateTime
 
@@ -20,38 +21,123 @@ abstract class FeedDAO {
 
     @Query(
         """
-        SELECT s.* FROM streams s
+        SELECT s.*, sst.progress_time
+        FROM streams s
+
+        LEFT JOIN stream_state sst
+        ON s.uid = sst.stream_id
+
+        LEFT JOIN stream_history sh
+        ON s.uid = sh.stream_id
 
         INNER JOIN feed f
         ON s.uid = f.stream_id
 
         ORDER BY s.upload_date IS NULL DESC, s.upload_date DESC, s.uploader ASC
-
         LIMIT 500
         """
     )
-    abstract fun getAllStreams(): Flowable<List<StreamEntity>>
+    abstract fun getAllStreams(): Flowable<List<StreamWithState>>
 
     @Query(
         """
-        SELECT s.* FROM streams s
+        SELECT s.*, sst.progress_time
+        FROM streams s
+
+        LEFT JOIN stream_state sst
+        ON s.uid = sst.stream_id
+
+        LEFT JOIN stream_history sh
+        ON s.uid = sh.stream_id
 
         INNER JOIN feed f
         ON s.uid = f.stream_id
 
         INNER JOIN feed_group_subscription_join fgs
         ON fgs.subscription_id = f.subscription_id
 
-        INNER JOIN feed_group fg
-        ON fg.uid = fgs.group_id
+        WHERE fgs.group_id = :groupId
+
+        ORDER BY s.upload_date IS NULL DESC, s.upload_date DESC, s.uploader ASC
+        LIMIT 500
+        """
+    )
+    abstract fun getAllStreamsForGroup(groupId: Long): Flowable<List<StreamWithState>>
+
+    /**
+     * @see StreamStateEntity.isFinished()
+     * @see StreamStateEntity.PLAYBACK_FINISHED_END_MILLISECONDS
+     * @return all of the non-live, never-played and non-finished streams in the feed
+     *         (all of the cited conditions must hold for a stream to be in the returned list)
+     */
+    @Query(
+        """
+        SELECT s.*, sst.progress_time
+        FROM streams s
+
+        LEFT JOIN stream_state sst
+        ON s.uid = sst.stream_id
+
+        LEFT JOIN stream_history sh
+        ON s.uid = sh.stream_id    
+            
+        INNER JOIN feed f
+        ON s.uid = f.stream_id
+
+        WHERE (
+            sh.stream_id IS NULL
+            OR sst.stream_id IS NULL
+            OR sst.progress_time < s.duration * 1000 - ${StreamStateEntity.PLAYBACK_FINISHED_END_MILLISECONDS}
+            OR sst.progress_time < s.duration * 1000 * 3 / 4
+            OR s.stream_type = 'LIVE_STREAM'
+            OR s.stream_type = 'AUDIO_LIVE_STREAM'
+        )
+
+        ORDER BY s.upload_date IS NULL DESC, s.upload_date DESC, s.uploader ASC
+        LIMIT 500
+        """
+    )
+    abstract fun getLiveOrNotPlayedStreams(): Flowable<List<StreamWithState>>
+
+    /**
+     * @see StreamStateEntity.isFinished()
+     * @see StreamStateEntity.PLAYBACK_FINISHED_END_MILLISECONDS
+     * @param groupId the group id to get streams of
+     * @return all of the non-live, never-played and non-finished streams for the given feed group
+     *         (all of the cited conditions must hold for a stream to be in the returned list)
+     */
+    @Query(
+        """
+        SELECT s.*, sst.progress_time
+        FROM streams s
+
+        LEFT JOIN stream_state sst
+        ON s.uid = sst.stream_id
+        
+        LEFT JOIN stream_history sh
+        ON s.uid = sh.stream_id
+        
+        INNER JOIN feed f
+        ON s.uid = f.stream_id
+
+        INNER JOIN feed_group_subscription_join fgs
+        ON fgs.subscription_id = f.subscription_id
 
         WHERE fgs.group_id = :groupId
+        AND (
+            sh.stream_id IS NULL
+            OR sst.stream_id IS NULL
+            OR sst.progress_time < s.duration * 1000 - ${StreamStateEntity.PLAYBACK_FINISHED_END_MILLISECONDS}
+            OR sst.progress_time < s.duration * 1000 * 3 / 4
+            OR s.stream_type = 'LIVE_STREAM'
+            OR s.stream_type = 'AUDIO_LIVE_STREAM'
+        )
 
         ORDER BY s.upload_date IS NULL DESC, s.upload_date DESC, s.uploader ASC
         LIMIT 500
         """
     )
-    abstract fun getAllStreamsFromGroup(groupId: Long): Flowable<List<StreamEntity>>
+    abstract fun getLiveOrNotPlayedStreamsForGroup(groupId: Long): Flowable<List<StreamWithState>>
 
     @Query(
         """

app/src/main/java/org/schabi/newpipe/database/history/dao/StreamHistoryDAO.java

@@ -21,7 +21,7 @@
 import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_ID;
 import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_TABLE;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.JOIN_STREAM_ID_ALIAS;
-import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_PROGRESS_TIME;
+import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_PROGRESS_MILLIS;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_STATE_TABLE;
 
 @Dao
@@ -80,7 +80,7 @@ public Flowable<List<StreamHistoryEntity>> listByService(final int serviceId) {
 
             + " LEFT JOIN "
             + "(SELECT " + JOIN_STREAM_ID + " AS " + JOIN_STREAM_ID_ALIAS + ", "
-            +  STREAM_PROGRESS_TIME
+            + STREAM_PROGRESS_MILLIS
             + " FROM " + STREAM_STATE_TABLE + " )"
             + " ON " + STREAM_ID + " = " + JOIN_STREAM_ID_ALIAS)
     public abstract Flowable<List<StreamStatisticsEntry>> getStatistics();

app/src/main/java/org/schabi/newpipe/database/playlist/PlaylistStreamEntry.kt

@@ -12,8 +12,8 @@ data class PlaylistStreamEntry(
     @Embedded
     val streamEntity: StreamEntity,
 
-    @ColumnInfo(name = StreamStateEntity.STREAM_PROGRESS_TIME, defaultValue = "0")
-    val progressTime: Long,
+    @ColumnInfo(name = StreamStateEntity.STREAM_PROGRESS_MILLIS, defaultValue = "0")
+    val progressMillis: Long,
 
     @ColumnInfo(name = PlaylistStreamEntity.JOIN_STREAM_ID)
     val streamId: Long,

app/src/main/java/org/schabi/newpipe/database/playlist/dao/PlaylistStreamDAO.java

@@ -25,7 +25,7 @@
 import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_ID;
 import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_TABLE;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.JOIN_STREAM_ID_ALIAS;
-import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_PROGRESS_TIME;
+import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_PROGRESS_MILLIS;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_STATE_TABLE;
 
 @Dao
@@ -64,7 +64,7 @@ default Flowable<List<PlaylistStreamEntity>> listByService(final int serviceId)
 
             + " LEFT JOIN "
             + "(SELECT " + JOIN_STREAM_ID + " AS " + JOIN_STREAM_ID_ALIAS + ", "
-            +  STREAM_PROGRESS_TIME
+            + STREAM_PROGRESS_MILLIS
             + " FROM " + STREAM_STATE_TABLE + " )"
             + " ON " + STREAM_ID + " = " + JOIN_STREAM_ID_ALIAS
 

app/src/main/java/org/schabi/newpipe/database/stream/StreamStatisticsEntry.kt

@@ -5,16 +5,16 @@ import androidx.room.Embedded
 import org.schabi.newpipe.database.LocalItem
 import org.schabi.newpipe.database.history.model.StreamHistoryEntity
 import org.schabi.newpipe.database.stream.model.StreamEntity
-import org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_PROGRESS_TIME
+import org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_PROGRESS_MILLIS
 import org.schabi.newpipe.extractor.stream.StreamInfoItem
 import java.time.OffsetDateTime
 
 class StreamStatisticsEntry(
     @Embedded
     val streamEntity: StreamEntity,
 
-    @ColumnInfo(name = STREAM_PROGRESS_TIME, defaultValue = "0")
-    val progressTime: Long,
+    @ColumnInfo(name = STREAM_PROGRESS_MILLIS, defaultValue = "0")
+    val progressMillis: Long,
 
     @ColumnInfo(name = StreamHistoryEntity.JOIN_STREAM_ID)
     val streamId: Long,

app/src/main/java/org/schabi/newpipe/database/stream/StreamWithState.kt

@@ -0,0 +1,14 @@
+package org.schabi.newpipe.database.stream
+
+import androidx.room.ColumnInfo
+import androidx.room.Embedded
+import org.schabi.newpipe.database.stream.model.StreamEntity
+import org.schabi.newpipe.database.stream.model.StreamStateEntity
+
+data class StreamWithState(
+    @Embedded
+    val stream: StreamEntity,
+
+    @ColumnInfo(name = StreamStateEntity.STREAM_PROGRESS_MILLIS)
+    val stateProgressMillis: Long?
+)

app/src/main/java/org/schabi/newpipe/database/stream/model/StreamStateEntity.java

@@ -5,7 +5,7 @@
 import androidx.room.Entity;
 import androidx.room.ForeignKey;
 
-import java.util.concurrent.TimeUnit;
+import java.util.Objects;
 
 import static androidx.room.ForeignKey.CASCADE;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.JOIN_STREAM_ID;
@@ -25,26 +25,31 @@ public class StreamStateEntity {
     // This additional field is required for the SQL query because 'stream_id' is used
     // for some other joins already
     public static final String JOIN_STREAM_ID_ALIAS = "stream_id_alias";
-    public static final String STREAM_PROGRESS_TIME = "progress_time";
+    public static final String STREAM_PROGRESS_MILLIS = "progress_time";
 
     /**
-     * Playback state will not be saved, if playback time is less than this threshold.
+     * Playback state will not be saved, if playback time is less than this threshold (5000ms = 5s).
      */
-    private static final int PLAYBACK_SAVE_THRESHOLD_START_SECONDS = 5;
+    private static final long PLAYBACK_SAVE_THRESHOLD_START_MILLISECONDS = 5000;
+
     /**
-     * Playback state will not be saved, if time left is less than this threshold.
+     * Stream will be considered finished if the playback time left exceeds this threshold
+     * (60000ms = 60s).
+     * @see #isFinished(long)
+     * @see org.schabi.newpipe.database.feed.dao.FeedDAO#getLiveOrNotPlayedStreams()
+     * @see org.schabi.newpipe.database.feed.dao.FeedDAO#getLiveOrNotPlayedStreamsForGroup(long)
      */
-    private static final int PLAYBACK_SAVE_THRESHOLD_END_SECONDS = 10;
+    public static final long PLAYBACK_FINISHED_END_MILLISECONDS = 60000;
 
     @ColumnInfo(name = JOIN_STREAM_ID)
     private long streamUid;
 
-    @ColumnInfo(name = STREAM_PROGRESS_TIME)
-    private long progressTime;
+    @ColumnInfo(name = STREAM_PROGRESS_MILLIS)
+    private long progressMillis;
 
-    public StreamStateEntity(final long streamUid, final long progressTime) {
+    public StreamStateEntity(final long streamUid, final long progressMillis) {
         this.streamUid = streamUid;
-        this.progressTime = progressTime;
+        this.progressMillis = progressMillis;
     }
 
     public long getStreamUid() {
@@ -55,27 +60,53 @@ public void setStreamUid(final long streamUid) {
         this.streamUid = streamUid;
     }
 
-    public long getProgressTime() {
-        return progressTime;
+    public long getProgressMillis() {
+        return progressMillis;
+    }
+
+    public void setProgressMillis(final long progressMillis) {
+        this.progressMillis = progressMillis;
     }
 
-    public void setProgressTime(final long progressTime) {
-        this.progressTime = progressTime;
+    /**
+     * The state will be considered valid, and thus be saved, if the progress is more than {@link
+     * #PLAYBACK_SAVE_THRESHOLD_START_MILLISECONDS} or at least 1/4 of the video length.
+     * @param durationInSeconds the duration of the stream connected with this state, in seconds
+     * @return whether this stream state entity should be saved or not
+     */
+    public boolean isValid(final long durationInSeconds) {
+        return progressMillis > PLAYBACK_SAVE_THRESHOLD_START_MILLISECONDS
+                || progressMillis > durationInSeconds * 1000 / 4;
     }
 
-    public boolean isValid(final int durationInSeconds) {
-        final int seconds = (int) TimeUnit.MILLISECONDS.toSeconds(progressTime);
-        return seconds > PLAYBACK_SAVE_THRESHOLD_START_SECONDS
-                && seconds < durationInSeconds - PLAYBACK_SAVE_THRESHOLD_END_SECONDS;
+    /**
+     * The video will be considered as finished, if the time left is less than {@link
+     * #PLAYBACK_FINISHED_END_MILLISECONDS} and the progress is at least 3/4 of the video length.
+     * The state will be saved anyway, so that it can be shown under stream info items, but the
+     * player will not resume if a state is considered as finished. Finished streams are also the
+     * ones that can be filtered out in the feed fragment.
+     * @see org.schabi.newpipe.database.feed.dao.FeedDAO#getLiveOrNotPlayedStreams()
+     * @see org.schabi.newpipe.database.feed.dao.FeedDAO#getLiveOrNotPlayedStreamsForGroup(long)
+     * @param durationInSeconds the duration of the stream connected with this state, in seconds
+     * @return whether the stream is finished or not
+     */
+    public boolean isFinished(final long durationInSeconds) {
+        return progressMillis >= durationInSeconds * 1000 - PLAYBACK_FINISHED_END_MILLISECONDS
+                && progressMillis >= durationInSeconds * 1000 * 3 / 4;
     }
 
     @Override
     public boolean equals(@Nullable final Object obj) {
         if (obj instanceof StreamStateEntity) {
             return ((StreamStateEntity) obj).streamUid == streamUid
-                    && ((StreamStateEntity) obj).progressTime == progressTime;
+                    && ((StreamStateEntity) obj).progressMillis == progressMillis;
         } else {
             return false;
         }
     }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(streamUid, progressMillis);
+    }
 }

app/src/main/java/org/schabi/newpipe/fragments/MainFragment.java

@@ -130,7 +130,7 @@ public void onCreateOptionsMenu(@NonNull final Menu menu,
             Log.d(TAG, "onCreateOptionsMenu() called with: "
                     + "menu = [" + menu + "], inflater = [" + inflater + "]");
         }
-        inflater.inflate(R.menu.main_fragment_menu, menu);
+        inflater.inflate(R.menu.menu_main_fragment, menu);
 
         final ActionBar supportActionBar = activity.getSupportActionBar();
         if (supportActionBar != null) {

app/src/main/java/org/schabi/newpipe/fragments/detail/VideoDetailFragment.java

@@ -1669,7 +1669,7 @@ private void updateProgressInfo(@NonNull final StreamInfo info) {
                 .onErrorComplete()
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(state -> {
-                    showPlaybackProgress(state.getProgressTime(), info.getDuration() * 1000);
+                    showPlaybackProgress(state.getProgressMillis(), info.getDuration() * 1000);
                     animate(binding.positionView, true, 500);
                     animate(binding.detailPositionView, true, 500);
                 }, e -> {

app/src/main/java/org/schabi/newpipe/info_list/holder/StreamMiniInfoItemHolder.java

@@ -66,7 +66,7 @@ public void updateFromItem(final InfoItem infoItem,
                 itemProgressView.setVisibility(View.VISIBLE);
                 itemProgressView.setMax((int) item.getDuration());
                 itemProgressView.setProgress((int) TimeUnit.MILLISECONDS
-                        .toSeconds(state2.getProgressTime()));
+                        .toSeconds(state2.getProgressMillis()));
             } else {
                 itemProgressView.setVisibility(View.GONE);
             }
@@ -121,10 +121,10 @@ public void updateState(final InfoItem infoItem,
             itemProgressView.setMax((int) item.getDuration());
             if (itemProgressView.getVisibility() == View.VISIBLE) {
                 itemProgressView.setProgressAnimated((int) TimeUnit.MILLISECONDS
-                        .toSeconds(state.getProgressTime()));
+                        .toSeconds(state.getProgressMillis()));
             } else {
                 itemProgressView.setProgress((int) TimeUnit.MILLISECONDS
-                        .toSeconds(state.getProgressTime()));
+                        .toSeconds(state.getProgressMillis()));
                 ViewUtils.animate(itemProgressView, true, 500);
             }
         } else if (itemProgressView.getVisibility() == View.VISIBLE) {