Rework content and sort filter framework

extractor/build.gradle

@@ -1,5 +1,6 @@
 plugins {
     id 'checkstyle'
+    id 'com.squareup.wire' version '4.5.2'
 }
 
 test {
@@ -18,6 +19,15 @@ checkstyle {
     toolVersion checkstyleVersion
 }
 
+checkstyleMain
+        // exclude the wire generated youtube protobuf files
+        .exclude ('org/schabi/newpipe/extractor/services/youtube/search/filter/protobuf/')
+
+wire {
+    java {
+    }
+}
+
 checkstyleTest {
     enabled false // do not checkstyle test files
 }

extractor/src/main/java/org/schabi/newpipe/extractor/ListInfo.java

@@ -1,22 +1,24 @@
 package org.schabi.newpipe.extractor;
 
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
 
 import java.util.List;
 
 public abstract class ListInfo<T extends InfoItem> extends Info {
     private List<T> relatedItems;
     private Page nextPage = null;
-    private final List<String> contentFilters;
-    private final String sortFilter;
+    private final List<FilterItem> contentFilters;
+    private final List<FilterItem> sortFilter;
 
     public ListInfo(final int serviceId,
                     final String id,
                     final String url,
                     final String originalUrl,
                     final String name,
-                    final List<String> contentFilter,
-                    final String sortFilter) {
+                    final List<FilterItem> contentFilter,
+                    final List<FilterItem> sortFilter) {
         super(serviceId, id, url, originalUrl, name);
         this.contentFilters = contentFilter;
         this.sortFilter = sortFilter;
@@ -50,11 +52,11 @@ public void setNextPage(final Page page) {
         this.nextPage = page;
     }
 
-    public List<String> getContentFilters() {
+    public List<FilterItem> getContentFilters() {
         return contentFilters;
     }
 
-    public String getSortFilter() {
+    public List<FilterItem> getSortFilter() {
         return sortFilter;
     }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/StreamingService.java

@@ -1,5 +1,7 @@
 package org.schabi.newpipe.extractor;
 
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+
 import org.schabi.newpipe.extractor.channel.ChannelExtractor;
 import org.schabi.newpipe.extractor.channel.tabs.ChannelTabExtractor;
 import org.schabi.newpipe.extractor.comments.CommentsExtractor;
@@ -246,23 +248,24 @@ public abstract CommentsExtractor getCommentsExtractor(ListLinkHandler linkHandl
     //////////////////////////////////////////////////////////////////////////*/
 
     public SearchExtractor getSearchExtractor(final String query,
-                                              final List<String> contentFilter,
-                                              final String sortFilter) throws ExtractionException {
+                                              final List<FilterItem> contentFilter,
+                                              final List<FilterItem> sortFilter)
+            throws ExtractionException {
         return getSearchExtractor(getSearchQHFactory()
                 .fromQuery(query, contentFilter, sortFilter));
     }
 
     public ChannelExtractor getChannelExtractor(final String id,
-                                                final List<String> contentFilter,
-                                                final String sortFilter)
+                                                final List<FilterItem> contentFilter,
+                                                final List<FilterItem> sortFilter)
             throws ExtractionException {
         return getChannelExtractor(getChannelLHFactory()
                 .fromQuery(id, contentFilter, sortFilter));
     }
 
     public PlaylistExtractor getPlaylistExtractor(final String id,
-                                                  final List<String> contentFilter,
-                                                  final String sortFilter)
+                                                  final List<FilterItem> contentFilter,
+                                                  final List<FilterItem> sortFilter)
             throws ExtractionException {
         return getPlaylistExtractor(getPlaylistLHFactory()
                 .fromQuery(id, contentFilter, sortFilter));
@@ -280,18 +283,18 @@ public ChannelExtractor getChannelExtractor(final String url) throws ExtractionE
         return getChannelExtractor(getChannelLHFactory().fromUrl(url));
     }
 
-    public ChannelTabExtractor getChannelTabExtractorFromId(final String id, final String tab)
+    public ChannelTabExtractor getChannelTabExtractorFromId(final String id, final FilterItem tab)
             throws ExtractionException {
         return getChannelTabExtractor(getChannelTabLHFactory().fromQuery(
-                id, Collections.singletonList(tab), ""));
+                id, List.of(tab), List.of()));
     }
 
     public ChannelTabExtractor getChannelTabExtractorFromIdAndBaseUrl(final String id,
-                                                                      final String tab,
+                                                                      final FilterItem tab,
                                                                       final String baseUrl)
             throws ExtractionException {
         return getChannelTabExtractor(getChannelTabLHFactory().fromQuery(
-                id, Collections.singletonList(tab), "", baseUrl));
+                id, List.of(tab), List.of(), baseUrl));
     }
 
     public PlaylistExtractor getPlaylistExtractor(final String url) throws ExtractionException {

extractor/src/main/java/org/schabi/newpipe/extractor/channel/tabs/ChannelTabExtractor.java

@@ -4,6 +4,7 @@
 import org.schabi.newpipe.extractor.ListExtractor;
 import org.schabi.newpipe.extractor.StreamingService;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 
 import javax.annotation.Nonnull;
 
@@ -17,9 +18,14 @@ protected ChannelTabExtractor(@Nonnull final StreamingService service,
         super(service, linkHandler);
     }
 
+    @Nonnull
+    public FilterItem getChannelTabType() {
+        return getLinkHandler().getContentFilters().get(0);
+    }
+
     @Nonnull
     @Override
     public String getName() {
-        return getLinkHandler().getContentFilters().get(0);
+        return getChannelTabType().getNameId().name();
     }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/channel/tabs/ChannelTabInfo.java

@@ -17,7 +17,7 @@ public class ChannelTabInfo extends ListInfo<InfoItem> {
 
     public ChannelTabInfo(final int serviceId,
                           @Nonnull final ListLinkHandler linkHandler) {
-        super(serviceId, linkHandler, linkHandler.getContentFilters().get(0));
+        super(serviceId, linkHandler, linkHandler.getContentFilters().get(0).getNameId().name());
     }
 
     /**

extractor/src/main/java/org/schabi/newpipe/extractor/channel/tabs/ChannelTabs.java

@@ -1,16 +1,35 @@
 package org.schabi.newpipe.extractor.channel.tabs;
 
+import static org.schabi.newpipe.extractor.search.filter.LibraryStringIds.CHANNEL_TAB_ALBUMS;
+import static org.schabi.newpipe.extractor.search.filter.LibraryStringIds.CHANNEL_TAB_CHANNELS;
+import static org.schabi.newpipe.extractor.search.filter.LibraryStringIds.CHANNEL_TAB_LIVESTREAMS;
+import static org.schabi.newpipe.extractor.search.filter.LibraryStringIds.CHANNEL_TAB_PLAYLISTS;
+import static org.schabi.newpipe.extractor.search.filter.LibraryStringIds.CHANNEL_TAB_SHORTS;
+import static org.schabi.newpipe.extractor.search.filter.LibraryStringIds.CHANNEL_TAB_TRACKS;
+import static org.schabi.newpipe.extractor.search.filter.LibraryStringIds.CHANNEL_TAB_VIDEOS;
+
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+
 /**
  * Constants of channel tabs supported by the extractor.
  */
 public final class ChannelTabs {
-    public static final String VIDEOS = "videos";
-    public static final String TRACKS = "tracks";
-    public static final String SHORTS = "shorts";
-    public static final String LIVESTREAMS = "livestreams";
-    public static final String CHANNELS = "channels";
-    public static final String PLAYLISTS = "playlists";
-    public static final String ALBUMS = "albums";
+    public static final int ID_VIDEOS = 0;
+    public static final int ID_TRACKS = 1;
+    public static final int ID_SHORTS = 2;
+    public static final int ID_LIVESTREAMS = 3;
+    public static final int ID_CHANNELS = 4;
+    public static final int ID_PLAYLISTS = 5;
+    public static final int ID_ALBUMS = 6;
+
+    public static final FilterItem VIDEOS = new FilterItem(ID_VIDEOS, CHANNEL_TAB_VIDEOS);
+    public static final FilterItem TRACKS = new FilterItem(ID_TRACKS, CHANNEL_TAB_TRACKS);
+    public static final FilterItem SHORTS = new FilterItem(ID_SHORTS, CHANNEL_TAB_SHORTS);
+    public static final FilterItem LIVESTREAMS =
+            new FilterItem(ID_LIVESTREAMS, CHANNEL_TAB_LIVESTREAMS);
+    public static final FilterItem CHANNELS = new FilterItem(ID_CHANNELS, CHANNEL_TAB_CHANNELS);
+    public static final FilterItem PLAYLISTS = new FilterItem(ID_PLAYLISTS, CHANNEL_TAB_PLAYLISTS);
+    public static final FilterItem ALBUMS = new FilterItem(ID_ALBUMS, CHANNEL_TAB_ALBUMS);
 
     private ChannelTabs() {
     }

extractor/src/main/java/org/schabi/newpipe/extractor/exceptions/UnsupportedTabException.java

@@ -1,7 +1,9 @@
 package org.schabi.newpipe.extractor.exceptions;
 
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+
 public final class UnsupportedTabException extends UnsupportedOperationException {
-    public UnsupportedTabException(final String unsupportedTab) {
+    public UnsupportedTabException(final FilterItem unsupportedTab) {
         super("Unsupported tab " + unsupportedTab);
     }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/feed/FeedInfo.java

@@ -1,5 +1,7 @@
 package org.schabi.newpipe.extractor.feed;
 
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+
 import org.schabi.newpipe.extractor.ListExtractor.InfoItemsPage;
 import org.schabi.newpipe.extractor.ListInfo;
 import org.schabi.newpipe.extractor.NewPipe;
@@ -8,6 +10,7 @@
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.extractor.utils.ExtractorHelper;
 
+
 import java.io.IOException;
 import java.util.List;
 
@@ -18,8 +21,8 @@ public FeedInfo(final int serviceId,
                     final String url,
                     final String originalUrl,
                     final String name,
-                    final List<String> contentFilter,
-                    final String sortFilter) {
+                    final List<FilterItem> contentFilter,
+                    final List<FilterItem> sortFilter) {
         super(serviceId, id, url, originalUrl, name, contentFilter, sortFilter);
     }
 

extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ListLinkHandler.java

@@ -1,20 +1,22 @@
 package org.schabi.newpipe.extractor.linkhandler;
 
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
+
 import java.util.Collections;
 import java.util.List;
 
 public class ListLinkHandler extends LinkHandler {
-    protected final List<String> contentFilters;
-    protected final String sortFilter;
+    protected final List<FilterItem> contentFilters;
+    protected final List<FilterItem> sortFilter;
 
     public ListLinkHandler(final String originalUrl,
                            final String url,
                            final String id,
-                           final List<String> contentFilters,
-                           final String sortFilter) {
+                           final List<FilterItem> selectedContentFilters,
+                           final List<FilterItem> selectedSortFilter) {
         super(originalUrl, url, id);
-        this.contentFilters = Collections.unmodifiableList(contentFilters);
-        this.sortFilter = sortFilter;
+        this.contentFilters = Collections.unmodifiableList(selectedContentFilters);
+        this.sortFilter = selectedSortFilter;
     }
 
     public ListLinkHandler(final ListLinkHandler handler) {
@@ -30,14 +32,14 @@ public ListLinkHandler(final LinkHandler handler) {
                 handler.url,
                 handler.id,
                 Collections.emptyList(),
-                "");
+                Collections.emptyList());
     }
 
-    public List<String> getContentFilters() {
+    public List<FilterItem> getContentFilters() {
         return contentFilters;
     }
 
-    public String getSortFilter() {
+    public List<FilterItem> getSortFilter() {
         return sortFilter;
     }
 }

extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.java

@@ -1,24 +1,29 @@
 package org.schabi.newpipe.extractor.linkhandler;
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
+import org.schabi.newpipe.extractor.search.filter.FilterItem;
 import org.schabi.newpipe.extractor.utils.Utils;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
 public abstract class ListLinkHandlerFactory extends LinkHandlerFactory {
 
     ///////////////////////////////////
     // To Override
     ///////////////////////////////////
 
-    public abstract String getUrl(String id, List<String> contentFilter, String sortFilter)
+    public abstract String getUrl(String id,
+                                  @Nonnull List<FilterItem> contentFilter,
+                                  @Nullable List<FilterItem> sortFilter)
             throws ParsingException, UnsupportedOperationException;
 
     public String getUrl(final String id,
-                         final List<String> contentFilter,
-                         final String sortFilter,
+                         final List<FilterItem> contentFilter,
+                         final List<FilterItem> sortFilter,
                          final String baseUrl)
             throws ParsingException, UnsupportedOperationException {
         return getUrl(id, contentFilter, sortFilter);
@@ -51,16 +56,16 @@ public ListLinkHandler fromId(final String id, final String baseUrl) throws Pars
         return new ListLinkHandler(super.fromId(id, baseUrl));
     }
 
-    public ListLinkHandler fromQuery(final String id,
-                                     final List<String> contentFilters,
-                                     final String sortFilter) throws ParsingException {
-        final String url = getUrl(id, contentFilters, sortFilter);
-        return new ListLinkHandler(url, url, id, contentFilters, sortFilter);
+    public ListLinkHandler fromQuery(final String query,
+                                     final List<FilterItem> contentFilter,
+                                     final List<FilterItem> sortFilter) throws ParsingException {
+        final String url = getUrl(query, contentFilter, sortFilter);
+        return new ListLinkHandler(url, url, query, contentFilter, sortFilter);
     }
 
     public ListLinkHandler fromQuery(final String id,
-                                     final List<String> contentFilters,
-                                     final String sortFilter,
+                                     final List<FilterItem> contentFilters,
+                                     final List<FilterItem> sortFilter,
                                      final String baseUrl) throws ParsingException {
         final String url = getUrl(id, contentFilters, sortFilter, baseUrl);
         return new ListLinkHandler(url, url, id, contentFilters, sortFilter);
@@ -74,31 +79,12 @@ public ListLinkHandler fromQuery(final String id,
      * @return the url corresponding to id without any filters applied
      */
     public String getUrl(final String id) throws ParsingException, UnsupportedOperationException {
-        return getUrl(id, new ArrayList<>(0), "");
+        return getUrl(id, List.of(), List.of());
     }
 
     @Override
-    public String getUrl(final String id, final String baseUrl) throws ParsingException {
-        return getUrl(id, new ArrayList<>(0), "", baseUrl);
-    }
-
-    /**
-     * Will returns content filter the corresponding extractor can handle like "channels", "videos",
-     * "music", etc.
-     *
-     * @return filter that can be applied when building a query for getting a list
-     */
-    public String[] getAvailableContentFilter() {
-        return new String[0];
-    }
-
-    /**
-     * Will returns sort filter the corresponding extractor can handle like "A-Z", "oldest first",
-     * "size", etc.
-     *
-     * @return filter that can be applied when building a query for getting a list
-     */
-    public String[] getAvailableSortFilter() {
-        return new String[0];
+    public String getUrl(final String id, final String baseUrl)
+            throws ParsingException, UnsupportedOperationException {
+        return getUrl(id, List.of(), List.of(), baseUrl);
     }
 }