feat && refactor: merge client upstream PR #8837 and extractor upstream PR #904(evermind-zz: content and sort filter framework) and refactor BiliBili and NicoNico service to fit in it. Also partially merge extractor PR #18 (34j: Add content filters).

InfinityLoop1308 · 34j · InfinityLoop1308 · commit 9e2248d1c80d · 2022-09-15T15:21:17.000+08:00
Co-authored-by: 34j &lt;55338215+34j@users.noreply.github.com&gt;
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/extractors/BilibiliChannelExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/extractors/BilibiliChannelExtractor.java
@@ -17,6 +17,7 @@
 import org.schabi.newpipe.extractor.exceptions.ReCaptchaException;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
 import org.schabi.newpipe.extractor.services.bilibili.linkHandler.BilibiliSearchQueryHandlerFactory;
+import org.schabi.newpipe.extractor.services.bilibili.search.filter.BilibiliFilters;
 import org.schabi.newpipe.extractor.services.bilibili.utils;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
@@ -59,7 +60,8 @@ public void onFetchPage(@Nonnull Downloader downloader) throws IOException, Extr
         try {
             json = JsonParser.object().from(response);
             userJson = JsonParser.object().from(userResponse);
-            String liveResponse = downloader.get(new BilibiliSearchQueryHandlerFactory().getUrl(getName(), Collections.singletonList("live_room"), "")).responseBody();
+            String liveResponse = downloader.get(new BilibiliSearchQueryHandlerFactory().getUrl(getName(),
+                    Collections.singletonList(new BilibiliFilters.BilibiliContentFilterItem("live_room", "search_type=live_room")), null)).responseBody();
             liveJson = JsonParser.object().from(liveResponse);
             String recordResponse = downloader.get("https://api.bilibili.com/x/polymer/space/seasons_series_list?mid=" +getId() +"&page_num=1&page_size=10").responseBody();
             JsonArray series_list = JsonParser.object().from(recordResponse).getObject("data").getObject("items_lists").getArray("series_list");
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliChannelLinkHandlerFactory.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliChannelLinkHandlerFactory.java
@@ -5,6 +5,7 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 
 public class BilibiliChannelLinkHandlerFactory extends ListLinkHandlerFactory{
     
@@ -34,7 +35,8 @@ public boolean onAcceptUrl(final String url) throws ParsingException {
     }
 
     @Override
-    public String getUrl(String id, List<String> contentFilter, String sortFilter) throws ParsingException {
+    public String getUrl(String id, final List<FilterItem> contentFilter,
+                         final List<FilterItem> sortFilter) throws ParsingException {
         return baseUrl + id;
     }
 
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliCommentsLinkHandlerFactory.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliCommentsLinkHandlerFactory.java
@@ -5,6 +5,7 @@
 import org.schabi.newpipe.extractor.exceptions.ExtractionException;
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 import org.schabi.newpipe.extractor.services.bilibili.utils;
 import org.schabi.newpipe.extractor.services.soundcloud.linkHandler.SoundcloudStreamLinkHandlerFactory;
 
@@ -42,7 +43,8 @@ public boolean onAcceptUrl(String url) throws ParsingException {
     }
 
     @Override
-    public String getUrl(String id, List<String> contentFilter, String sortFilter) throws ParsingException {
+    public String getUrl(String id, final List<FilterItem> contentFilter,
+                         final List<FilterItem> sortFilter) throws ParsingException {
         id = id.startsWith("BV")? String.valueOf(new utils().bv2av(id)) :id;
         if(id.contains("&root")){
             return "https://api.bilibili.com/x/v2/reply/reply?type=1&ps=20&oid=" + id;
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliFeedLinkHandlerFactory.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliFeedLinkHandlerFactory.java
@@ -4,11 +4,13 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 
 public class BilibiliFeedLinkHandlerFactory extends ListLinkHandlerFactory{
 
     @Override
-    public String getUrl(String id, List<String> contentFilter, String sortFilter) throws ParsingException {
+    public String getUrl(String id, final List<FilterItem> contentFilter,
+                         final List<FilterItem> sortFilter) throws ParsingException {
         // TODO Auto-generated method stub
         return "https://www.bilibili.com";
     }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliSearchQueryHandlerFactory.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/linkHandler/BilibiliSearchQueryHandlerFactory.java
@@ -6,6 +6,10 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.SearchQueryHandlerFactory;
+import org.schabi.newpipe.extractor.search.filter.Filter;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+import org.schabi.newpipe.extractor.services.bilibili.search.filter.BilibiliFilters;
+import org.schabi.newpipe.extractor.services.niconico.search.filter.NiconicoFilters;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
@@ -17,39 +21,34 @@ public class BilibiliSearchQueryHandlerFactory extends SearchQueryHandlerFactory
     private static final String VIDEOS = "video";
     private static final String LIVE = "live_room";
     private static final String USER = "bili_user";
-    private static final String SEARCH_URL = "https://api.bilibili.com/x/web-interface/search/type?search_type=";
+    private static final String SEARCH_URL = "https://api.bilibili.com/x/web-interface/search/type?";
+
+    private final BilibiliFilters searchFilters = new BilibiliFilters();
 
     @Override
-    public String getUrl(final String query, final List<String> contentFilters, final String sortFilter)
+    public String getUrl(final String query, final List<FilterItem> selectedContentFilter,
+                         final List<FilterItem> selectedSortFilter)
             throws ParsingException {
-        try {
-            if (!contentFilters.isEmpty()) {
-                final String contentFilter = contentFilters.get(0);
-                final String searchString = query;
-                switch (contentFilter) {
-                    case VIDEOS:
-                    default:
-                        return SEARCH_URL + VIDEOS + "&keyword=" + URLEncoder.encode(searchString, UTF_8) + "&page=1";
-                    case LIVE:
-                        return SEARCH_URL + LIVE + "&keyword=" + URLEncoder.encode(searchString, UTF_8) + "&page=1";
-                    case USER:
-                        return SEARCH_URL + USER + "&keyword=" + URLEncoder.encode(searchString, UTF_8) + "&page=1";
-                }
-            }
-
-            return SEARCH_URL + VIDEOS + "&keyword=" + URLEncoder.encode(query, UTF_8) + "&page=1";
 
+        searchFilters.setSelectedSortFilter(selectedSortFilter);
+        searchFilters.setSelectedContentFilter(selectedContentFilter);
+
+        final String filterQuery = searchFilters.evaluateSelectedContentFilters();
+
+        try {
+            return SEARCH_URL + filterQuery + "&keyword=" + URLEncoder.encode(query, UTF_8) + "&page=1";
         } catch (final UnsupportedEncodingException e) {
             throw new ParsingException("query \"" + query + "\" could not be encoded", e);
         }
     }
 
     @Override
-    public String[] getAvailableContentFilter() {
-        return new String[]{
-                VIDEOS,
-                LIVE,
-                USER
-        };
+    public Filter getAvailableContentFilter() {
+        return searchFilters.getContentFilters();
+    }
+
+    @Override
+    public FilterItem getFilterItem(final int filterId) {
+        return searchFilters.getFilterItem(filterId);
     }
 }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/search/filter/BilibiliFilters.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bilibili/search/filter/BilibiliFilters.java
@@ -0,0 +1,65 @@
+package org.schabi.newpipe.extractor.services.bilibili.search.filter;
+
+import org.schabi.newpipe.extractor.search.filter.Filter;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+import org.schabi.newpipe.extractor.search.filter.SearchFiltersBase;
+import org.schabi.newpipe.extractor.services.bandcamp.search.filter.BandcampFilters;
+import org.schabi.newpipe.extractor.services.niconico.search.filter.NiconicoFilters;
+
+public class BilibiliFilters extends SearchFiltersBase {
+    private static final String VIDEOS = "Video";
+    private static final String LIVES = "LiveRoom";
+    private static final String USERS = "Channel";
+
+    public BilibiliFilters() {
+        init();
+        build();
+    }
+
+    public String evaluateSelectedContentFilters() {
+        if (selectedSortFilter != null) {
+            String sortQuery = "";
+
+            if (selectedContentFilter != null && !selectedContentFilter.isEmpty()) {
+                final BilibiliFilters.BilibiliContentFilterItem contentItem =
+                        // we assume that there is just one content filter
+                        (BilibiliFilters.BilibiliContentFilterItem) selectedContentFilter.get(0);
+                if (contentItem != null) {
+                    if (!contentItem.query.isEmpty()) {
+                        sortQuery = "&" + contentItem.query;
+                    }
+                }
+            }
+            return sortQuery;
+        }
+        return "";
+    }
+    @Override
+    protected void init() {
+        /* content filters */
+        final int contentFilterVideos = builder.addFilterItem(
+                new BilibiliFilters.BilibiliContentFilterItem(VIDEOS, "search_type=video"));
+        final int contentFilterLives = builder.addFilterItem(
+                new BilibiliFilters.BilibiliContentFilterItem(LIVES, "search_type=live_room"));
+        final int contentFilterUsers = builder.addFilterItem(
+                new BilibiliFilters.BilibiliContentFilterItem(USERS, "search_type=bili_user"));
+
+        this.defaultContentFilterId = contentFilterVideos;
+
+        /* content filters with sort filters */
+        addContentFilter(builder.createSortGroup(null, true, new FilterItem[]{
+                builder.getFilterForId(contentFilterVideos),
+                builder.getFilterForId(contentFilterLives),
+                builder.getFilterForId(contentFilterUsers),
+        }));
+    }
+
+    public static class BilibiliContentFilterItem extends FilterItem {
+        private final String query;
+
+        public BilibiliContentFilterItem(final String name, final String query) {
+            super(Filter.ITEM_IDENTIFIER_UNKNOWN, name);
+            this.query = query;
+        }
+    }
+}
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/linkHandler/NiconicoSearchQueryHandlerFactory.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/linkHandler/NiconicoSearchQueryHandlerFactory.java
@@ -4,7 +4,10 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.SearchQueryHandlerFactory;
+import org.schabi.newpipe.extractor.search.filter.Filter;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 import org.schabi.newpipe.extractor.services.niconico.NiconicoService;
+import org.schabi.newpipe.extractor.services.niconico.search.filter.NiconicoFilters;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
@@ -15,13 +18,20 @@ public class NiconicoSearchQueryHandlerFactory extends SearchQueryHandlerFactory
     private static final String SEARCH_URL
             = "https://api.search.nicovideo.jp/api/v2/snapshot/video/contents/search";
 
+    private final NiconicoFilters searchFilters = new NiconicoFilters();
+
     @Override
     public String getUrl(final String id,
-                         final List<String> contentFilter,
-                         final String sortFilter) throws ParsingException {
+                         final List<FilterItem> selectedContentFilter,
+                         final List<FilterItem> selectedSortFilter) throws ParsingException {
+
+        searchFilters.setSelectedSortFilter(selectedSortFilter);
+        searchFilters.setSelectedContentFilter(selectedContentFilter);
+
+        final String filterQuery = searchFilters.evaluateSelectedContentFilters();
+
         try {
-            return SEARCH_URL + "?q=" + URLEncoder.encode(id, UTF_8)
-                    + "&targets=title,description,tags"
+            return SEARCH_URL + "?q=" + URLEncoder.encode(id, UTF_8) + filterQuery
                     + "&fields=contentId,title,userId,channelId"
                     + ",viewCounter,lengthSeconds,thumbnailUrl,startTime"
                     + "&_sort=-viewCounter"
@@ -34,9 +44,12 @@ public String getUrl(final String id,
     }
 
     @Override
-    public String[] getAvailableContentFilter() {
-        return new String[] {
-                "all"
-        };
+    public Filter getAvailableContentFilter() {
+        return searchFilters.getContentFilters();
+    }
+
+    @Override
+    public FilterItem getFilterItem(final int filterId) {
+        return searchFilters.getFilterItem(filterId);
     }
 }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/linkHandler/NiconicoTrendLinkHandlerFactory.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/linkHandler/NiconicoTrendLinkHandlerFactory.java
@@ -2,6 +2,7 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 import org.schabi.newpipe.extractor.services.niconico.NiconicoService;
 
 import java.util.List;
@@ -18,8 +19,8 @@ public boolean onAcceptUrl(final String url) throws ParsingException {
     }
 
     @Override
-    public String getUrl(final String id, final List<String> contentFilter,
-                         final String sortFilter) throws ParsingException {
+    public String getUrl(final String id, final List<FilterItem> contentFilter,
+                         final List<FilterItem> sortFilter) throws ParsingException {
         return NiconicoService.DAILY_TREND_URL;
     }
 }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/linkHandler/NiconicoUserLinkHandlerFactory.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/linkHandler/NiconicoUserLinkHandlerFactory.java
@@ -2,6 +2,7 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 import org.schabi.newpipe.extractor.services.niconico.NiconicoService;
 import org.schabi.newpipe.extractor.utils.Parser;
 
@@ -19,8 +20,8 @@ public boolean onAcceptUrl(final String url) throws ParsingException {
     }
 
     @Override
-    public String getUrl(final String id, final List<String> contentFilter,
-                         final String sortFilter) throws ParsingException {
+    public String getUrl(final String id, final List<FilterItem> contentFilter,
+                         final List<FilterItem> sortFilter) throws ParsingException {
         return NiconicoService.USER_URL + id;
     }
 }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/search/filter/NiconicoFilters.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/niconico/search/filter/NiconicoFilters.java
@@ -0,0 +1,62 @@
+package org.schabi.newpipe.extractor.services.niconico.search.filter;
+
+import org.schabi.newpipe.extractor.search.filter.Filter;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+import org.schabi.newpipe.extractor.search.filter.SearchFiltersBase;
+import org.schabi.newpipe.extractor.services.bandcamp.search.filter.BandcampFilters;
+
+public class NiconicoFilters extends SearchFiltersBase {
+
+    private static final String ALL = "All";
+    private static final String TAGS_ONLY = "TagsOnly";
+
+    public NiconicoFilters() {
+        init();
+        build();
+    }
+
+    @Override
+    public String evaluateSelectedContentFilters() {
+        if (selectedSortFilter != null) {
+            String sortQuery = "";
+
+            if (selectedContentFilter != null && !selectedContentFilter.isEmpty()) {
+                final NiconicoFilters.NiconicoContentFilterItem contentItem =
+                        // we assume that there is just one content filter
+                        (NiconicoFilters.NiconicoContentFilterItem ) selectedContentFilter.get(0);
+                if (contentItem != null) {
+                    if (!contentItem.query.isEmpty()) {
+                        sortQuery = "&" + contentItem.query;
+                    }
+                }
+            }
+            return sortQuery;
+        }
+        return "";
+    }
+
+    @Override
+    protected void init() {
+        /* content filters */
+        final int contentFilterAll = builder.addFilterItem(
+                new NiconicoFilters.NiconicoContentFilterItem(ALL, "targets=title,description,tags"));
+        final int contentFilterTagsOnly = builder.addFilterItem(
+                new NiconicoFilters.NiconicoContentFilterItem(TAGS_ONLY, "targets=tagsExact"));
+        this.defaultContentFilterId = contentFilterAll;
+
+        /* content filters with sort filters */
+        addContentFilter(builder.createSortGroup(null, true, new FilterItem[]{
+                builder.getFilterForId(contentFilterAll),
+                builder.getFilterForId(contentFilterTagsOnly),
+        }));
+    }
+
+    public static class NiconicoContentFilterItem extends FilterItem {
+        private final String query;
+
+        public NiconicoContentFilterItem(final String name, final String query) {
+            super(Filter.ITEM_IDENTIFIER_UNKNOWN, name);
+            this.query = query;
+        }
+    }
+}
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/search/filter/YoutubeFilters.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/search/filter/YoutubeFilters.java
@@ -29,6 +29,7 @@ public final class YoutubeFilters extends SearchFiltersBase {
     public static final String CHANNELS = "channels";
     public static final String PLAYLISTS = "playlists";
     public static final String MOVIES = "movies";
+    public static final String LIVES = "Lives";
 
     public static final String MUSIC_SONGS = "music_songs";
     public static final String MUSIC_VIDEOS = "music_videos";

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`
`6`	`6`	`import org.schabi.newpipe.extractor.exceptions.ParsingException;`
`7`	`7`	`import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory;`
	`8`	`+import org.schabi.newpipe.extractor.search.filter.FilterItem;`
`8`	`9`
`9`	`10`	`public class BilibiliChannelLinkHandlerFactory extends ListLinkHandlerFactory{`
`10`	`11`
`@@ -34,7 +35,8 @@ public boolean onAcceptUrl(final String url) throws ParsingException {`
`34`	`35`	`}`
`35`	`36`
`36`	`37`	`@Override`
`37`		`- public String getUrl(String id, List<String> contentFilter, String sortFilter) throws ParsingException {`
	`38`	`+ public String getUrl(String id, final List<FilterItem> contentFilter,`
	`39`	`+ final List<FilterItem> sortFilter) throws ParsingException {`
`38`	`40`	`return baseUrl + id;`
`39`	`41`	`}`
`40`	`42`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`import org.schabi.newpipe.extractor.exceptions.ParsingException;`
`4`	`4`	`import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory;`
	`5`	`+import org.schabi.newpipe.extractor.search.filter.FilterItem;`
`5`	`6`	`import org.schabi.newpipe.extractor.services.niconico.NiconicoService;`
`6`	`7`
`7`	`8`	`import java.util.List;`
`@@ -18,8 +19,8 @@ public boolean onAcceptUrl(final String url) throws ParsingException {`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`@Override`
`21`		`- public String getUrl(final String id, final List<String> contentFilter,`
`22`		`- final String sortFilter) throws ParsingException {`
	`22`	`+ public String getUrl(final String id, final List<FilterItem> contentFilter,`
	`23`	`+ final List<FilterItem> sortFilter) throws ParsingException {`
`23`	`24`	`return NiconicoService.DAILY_TREND_URL;`
`24`	`25`	`}`
`25`	`26`	`}`