Merge pull request #782 from Bnyro/master

feat(rss feed): add optional query parameter 'filter' ('shorts' or 'videos')

Author: Bnyro

src/main/java/me/kavin/piped/server/ServerLauncher.java

@@ -315,7 +315,8 @@ AsyncServlet mainServlet(Executor executor) {
                     }
                 })).map(GET, "/feed/rss", AsyncServlet.ofBlocking(executor, request -> {
                     try {
-                        return getRawResponse(FeedHandlers.feedResponseRSS(request.getQueryParameter("authToken")),
+                        return getRawResponse(FeedHandlers.feedResponseRSS(request.getQueryParameter("authToken"),
+                                        request.getQueryParameter("filter")),
                                 "application/atom+xml", "public, s-maxage=120");
                     } catch (Exception e) {
                         return getErrorResponse(e, request.getPath());
@@ -339,7 +340,8 @@ AsyncServlet mainServlet(Executor executor) {
                 })).map(GET, "/feed/unauthenticated/rss", AsyncServlet.ofBlocking(executor, request -> {
                     try {
                         return getRawResponse(FeedHandlers.unauthenticatedFeedResponseRSS(
-                                getArray(request.getQueryParameter("channels"))
+                                getArray(request.getQueryParameter("channels")),
+                                request.getQueryParameter("filter")
                         ), "application/atom+xml", "public, s-maxage=120");
                     } catch (Exception e) {
                         return getErrorResponse(e, request.getPath());

src/main/java/me/kavin/piped/server/handlers/auth/FeedHandlers.java

@@ -21,6 +21,7 @@
 import org.hibernate.StatelessSession;
 import org.schabi.newpipe.extractor.channel.ChannelInfo;
 
+import javax.annotation.Nullable;
 import java.io.IOException;
 import java.util.*;
 import java.util.concurrent.TimeUnit;
@@ -119,7 +120,7 @@ public static byte[] feedResponse(String session) throws IOException {
         return null;
     }
 
-    public static byte[] feedResponseRSS(String session) throws FeedException {
+    public static byte[] feedResponseRSS(String session, @Nullable String filter) throws FeedException {
 
         if (StringUtils.isBlank(session))
             ExceptionHandler.throwErrorResponse(new InvalidRequestResponse("session is a required parameter"));
@@ -131,6 +132,7 @@ public static byte[] feedResponseRSS(String session) throws FeedException {
                 SyndFeed feed = FeedHelpers.createRssFeed(user.getUsername());
 
                 final List<SyndEntry> entries = FeedHelpers.generateAuthenticatedFeed(s, user.getId(), 100)
+                        .filter(FeedHelpers.createFeedFilter(filter))
                         .map(video -> {
                             var channel = video.getChannel();
                             return ChannelHelpers.createEntry(video, channel);
@@ -173,7 +175,7 @@ public static byte[] unauthenticatedFeedResponse(String[] channelIds) throws Exc
         }
     }
 
-    public static byte[] unauthenticatedFeedResponseRSS(String[] channelIds) throws Exception {
+    public static byte[] unauthenticatedFeedResponseRSS(String[] channelIds, @Nullable String filter) throws Exception {
 
         Set<String> filteredChannels = Arrays.stream(channelIds)
                 .filter(ChannelHelpers::isValidId)
@@ -183,7 +185,9 @@ public static byte[] unauthenticatedFeedResponseRSS(String[] channelIds) throws
             ExceptionHandler.throwErrorResponse(new InvalidRequestResponse("No valid channel IDs provided"));
 
         try (StatelessSession s = DatabaseSessionFactory.createStatelessSession()) {
-            List<Video> videos = FeedHelpers.generateUnauthenticatedFeed(s, filteredChannels, 100).toList();
+            List<Video> videos = FeedHelpers.generateUnauthenticatedFeed(s, filteredChannels, 100)
+                    .filter(FeedHelpers.createFeedFilter(filter))
+                    .toList();
 
             List<SyndEntry> entries = videos.stream()
                     .map(video -> ChannelHelpers.createEntry(video, video.getChannel()))

src/main/java/me/kavin/piped/utils/FeedHelpers.java

@@ -16,6 +16,7 @@
 import java.util.Comparator;
 import java.util.Date;
 import java.util.Set;
+import java.util.function.Predicate;
 import java.util.stream.Stream;
 
 import static me.kavin.piped.utils.URLUtils.rewriteURL;
@@ -79,6 +80,14 @@ public static SyndFeed createRssFeed(@Nullable String username) {
         return feed;
     }
 
+    public static Predicate<Video> createFeedFilter(@Nullable String filter) {
+        return video -> switch (filter) {
+            case "shorts" -> video.isShort();
+            case "videos" -> !video.isShort();
+            case null, default -> true;
+        };
+    }
+
     public static Stream<SubscriptionChannel> generateSubscriptionsList(Stream<Channel> channels) {
         return channels.parallel()
                 .filter(channel -> channel.getUploader() != null)