fix: make ChannelTabExtractorBuilder serializable

This commit is contained in:
ThetaDev 2023-04-16 15:24:19 +02:00
parent 6e0ffafd06
commit 308fc434fe
8 changed files with 140 additions and 114 deletions

View File

@ -3,6 +3,7 @@ package org.schabi.newpipe.extractor.linkhandler;
import org.schabi.newpipe.extractor.StreamingService; import org.schabi.newpipe.extractor.StreamingService;
import org.schabi.newpipe.extractor.channel.ChannelTabExtractor; import org.schabi.newpipe.extractor.channel.ChannelTabExtractor;
import java.io.Serializable;
import java.util.Collections; import java.util.Collections;
/** /**
@ -22,7 +23,7 @@ import java.util.Collections;
*/ */
public class ReadyChannelTabListLinkHandler extends ListLinkHandler { public class ReadyChannelTabListLinkHandler extends ListLinkHandler {
public interface ChannelTabExtractorBuilder { public interface ChannelTabExtractorBuilder extends Serializable {
ChannelTabExtractor build(StreamingService service, ListLinkHandler linkHandler); ChannelTabExtractor build(StreamingService service, ListLinkHandler linkHandler);
} }

View File

@ -8,10 +8,6 @@ import com.grack.nanojson.JsonArray;
import com.grack.nanojson.JsonObject; import com.grack.nanojson.JsonObject;
import org.jsoup.Jsoup; import org.jsoup.Jsoup;
import org.schabi.newpipe.extractor.InfoItem;
import org.schabi.newpipe.extractor.ListExtractor;
import org.schabi.newpipe.extractor.MultiInfoItemsCollector;
import org.schabi.newpipe.extractor.Page;
import org.schabi.newpipe.extractor.StreamingService; import org.schabi.newpipe.extractor.StreamingService;
import org.schabi.newpipe.extractor.channel.ChannelExtractor; import org.schabi.newpipe.extractor.channel.ChannelExtractor;
import org.schabi.newpipe.extractor.channel.ChannelTabExtractor; import org.schabi.newpipe.extractor.channel.ChannelTabExtractor;
@ -22,8 +18,6 @@ import org.schabi.newpipe.extractor.exceptions.ReCaptchaException;
import org.schabi.newpipe.extractor.linkhandler.ChannelTabs; import org.schabi.newpipe.extractor.linkhandler.ChannelTabs;
import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler; import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
import org.schabi.newpipe.extractor.linkhandler.ReadyChannelTabListLinkHandler; import org.schabi.newpipe.extractor.linkhandler.ReadyChannelTabListLinkHandler;
import org.schabi.newpipe.extractor.services.bandcamp.extractors.streaminfoitem.BandcampDiscographStreamInfoItemExtractor;
import org.schabi.newpipe.extractor.services.bandcamp.linkHandler.BandcampChannelTabHandler;
import org.schabi.newpipe.extractor.services.bandcamp.linkHandler.BandcampChannelTabLinkHandlerFactory; import org.schabi.newpipe.extractor.services.bandcamp.linkHandler.BandcampChannelTabLinkHandlerFactory;
import java.io.IOException; import java.io.IOException;
@ -117,16 +111,21 @@ public class BandcampChannelExtractor extends ChannelExtractor {
@Override @Override
public List<ListLinkHandler> getTabs() throws ParsingException { public List<ListLinkHandler> getTabs() throws ParsingException {
final JsonArray discography = channelInfo.getArray("discography"); final JsonArray discography = channelInfo.getArray("discography");
final TabExtractorBuilder builder = new TabExtractorBuilder(discography);
final List<ListLinkHandler> tabs = new ArrayList<>(); final List<ListLinkHandler> tabs = new ArrayList<>();
tabs.add(new ReadyChannelTabListLinkHandler(getUrl(), getId(),
ChannelTabs.TRACKS, this::buildTracksTabExtractor)); if (discography.stream().anyMatch(o -> (
(JsonObject) o).getString("item_type").equals("track"))) {
tabs.add(new ReadyChannelTabListLinkHandler(getUrl(), getId(),
ChannelTabs.TRACKS, builder));
}
if (discography.stream().anyMatch(o -> ( if (discography.stream().anyMatch(o -> (
(JsonObject) o).getString("item_type").equals("album"))) { (JsonObject) o).getString("item_type").equals("album"))) {
tabs.add(new BandcampChannelTabHandler( tabs.add(new ReadyChannelTabListLinkHandler(
getUrl() + BandcampChannelTabLinkHandlerFactory.URL_SUFFIX, getUrl() + BandcampChannelTabLinkHandlerFactory.URL_SUFFIX,
getId(), ChannelTabs.ALBUMS, discography)); getId(), ChannelTabs.ALBUMS, builder));
} }
return tabs; return tabs;
@ -144,41 +143,18 @@ public class BandcampChannelExtractor extends ChannelExtractor {
return channelInfo.getString("name"); return channelInfo.getString("name");
} }
private ChannelTabExtractor buildTracksTabExtractor(final StreamingService service, private static class TabExtractorBuilder
final ListLinkHandler linkHandler) { implements ReadyChannelTabListLinkHandler.ChannelTabExtractorBuilder {
return new ChannelTabExtractor(service, linkHandler) { private final JsonArray discography;
@Nonnull
@Override
public InfoItemsPage<InfoItem> getInitialPage() throws ExtractionException {
final MultiInfoItemsCollector collector =
new MultiInfoItemsCollector(getServiceId());
final JsonArray discography = channelInfo.getArray("discography"); TabExtractorBuilder(final JsonArray discography) {
this.discography = discography;
}
for (int i = 0; i < discography.size(); i++) { @Override
// A discograph is as an item appears in a discography public ChannelTabExtractor build(final StreamingService service,
final JsonObject discograph = discography.getObject(i); final ListLinkHandler linkHandler) {
return BandcampChannelTabExtractor.fromDiscography(service, linkHandler, discography);
if (!discograph.getString("item_type").equals("track")) { }
continue;
}
collector.commit(
new BandcampDiscographStreamInfoItemExtractor(discograph, getUrl()));
}
return new InfoItemsPage<>(collector, null);
}
@Override
public InfoItemsPage<InfoItem> getPage(final Page page) {
return ListExtractor.InfoItemsPage.emptyPage();
}
@Override
public void onFetchPage(@Nonnull final Downloader downloader) {
// nothing to do here, as data was already fetched
}
};
} }
} }

View File

@ -9,34 +9,49 @@ import org.schabi.newpipe.extractor.StreamingService;
import org.schabi.newpipe.extractor.channel.ChannelTabExtractor; import org.schabi.newpipe.extractor.channel.ChannelTabExtractor;
import org.schabi.newpipe.extractor.downloader.Downloader; import org.schabi.newpipe.extractor.downloader.Downloader;
import org.schabi.newpipe.extractor.exceptions.ExtractionException; import org.schabi.newpipe.extractor.exceptions.ExtractionException;
import org.schabi.newpipe.extractor.exceptions.ParsingException;
import org.schabi.newpipe.extractor.linkhandler.ChannelTabs; import org.schabi.newpipe.extractor.linkhandler.ChannelTabs;
import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler; import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
import org.schabi.newpipe.extractor.services.bandcamp.linkHandler.BandcampChannelTabHandler; import org.schabi.newpipe.extractor.services.bandcamp.extractors.streaminfoitem.BandcampDiscographStreamInfoItemExtractor;
import javax.annotation.Nonnull; import javax.annotation.Nonnull;
import java.io.IOException; import java.io.IOException;
public class BandcampChannelTabExtractor extends ChannelTabExtractor { public class BandcampChannelTabExtractor extends ChannelTabExtractor {
private JsonArray discography;
private final String filter;
public BandcampChannelTabExtractor(final StreamingService service, public BandcampChannelTabExtractor(final StreamingService service,
final ListLinkHandler linkHandler) { final ListLinkHandler linkHandler) {
super(service, linkHandler); super(service, linkHandler);
}
@Nonnull final String tab = linkHandler.getContentFilters().get(0);
private JsonArray getDiscographs() throws ExtractionException { switch (tab) {
final ListLinkHandler tabHandler = getLinkHandler(); case ChannelTabs.TRACKS:
if (tabHandler instanceof BandcampChannelTabHandler) { filter = "track";
return ((BandcampChannelTabHandler) tabHandler).getDiscographs(); break;
} else { case ChannelTabs.ALBUMS:
final JsonObject artistDetails = BandcampExtractorHelper.getArtistDetails(getId()); filter = "album";
return artistDetails.getArray("discography"); break;
default:
throw new IllegalArgumentException("unsupported channel tab: " + tab);
} }
} }
public static BandcampChannelTabExtractor fromDiscography(final StreamingService service,
final ListLinkHandler linkHandler,
final JsonArray discography) {
final BandcampChannelTabExtractor tabExtractor =
new BandcampChannelTabExtractor(service, linkHandler);
tabExtractor.discography = discography;
return tabExtractor;
}
@Override @Override
public void onFetchPage(@Nonnull final Downloader downloader) { public void onFetchPage(@Nonnull final Downloader downloader) throws ParsingException {
if (!getTab().equals(ChannelTabs.ALBUMS)) { if (discography == null) {
throw new IllegalArgumentException("tab " + getTab() + " not supported"); final JsonObject artistDetails = BandcampExtractorHelper.getArtistDetails(getId());
discography = artistDetails.getArray("discography");
} }
} }
@ -45,14 +60,26 @@ public class BandcampChannelTabExtractor extends ChannelTabExtractor {
public InfoItemsPage<InfoItem> getInitialPage() throws IOException, ExtractionException { public InfoItemsPage<InfoItem> getInitialPage() throws IOException, ExtractionException {
final MultiInfoItemsCollector collector = new MultiInfoItemsCollector(getServiceId()); final MultiInfoItemsCollector collector = new MultiInfoItemsCollector(getServiceId());
final JsonArray discography = getDiscographs(); for (int i = 0; i < discography.size(); i++) {
final String baseUrl = getBaseUrl(); // A discograph is as an item appears in a discography
discography.stream() final JsonObject discograph = discography.getObject(i);
.filter(discograph -> discograph instanceof JsonObject final String itemType = discograph.getString("item_type", "");
&& ((JsonObject) discograph).getString("item_type").equals("album"))
.forEach(discograph -> collector.commit(new BandcampAlbumInfoItemExtractor( if (!itemType.equals(filter)) {
(JsonObject) discograph, baseUrl)) continue;
); }
switch (itemType) {
case "track":
collector.commit(new BandcampDiscographStreamInfoItemExtractor(
discograph, getUrl()));
break;
case "album":
collector.commit(new BandcampAlbumInfoItemExtractor(
discograph, getUrl()));
break;
}
}
return new InfoItemsPage<>(collector, null); return new InfoItemsPage<>(collector, null);
} }

View File

@ -119,6 +119,7 @@ public final class BandcampExtractorHelper {
/** /**
* Whether the URL points to a radio kiosk. * Whether the URL points to a radio kiosk.
*
* @param url the URL to check * @param url the URL to check
* @return true if the URL matches {@code https://bandcamp.com/?show=SHOW_ID} * @return true if the URL matches {@code https://bandcamp.com/?show=SHOW_ID}
*/ */

View File

@ -1,20 +0,0 @@
package org.schabi.newpipe.extractor.services.bandcamp.linkHandler;
import com.grack.nanojson.JsonArray;
import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
import java.util.Collections;
public class BandcampChannelTabHandler extends ListLinkHandler {
private final JsonArray discographs;
public BandcampChannelTabHandler(final String url, final String id, final String tab,
final JsonArray discographs) {
super(url, url, id, Collections.singletonList(tab), "");
this.discographs = discographs;
}
public JsonArray getDiscographs() {
return discographs;
}
}

View File

@ -83,7 +83,7 @@ public class MediaCCCConferenceExtractor extends ChannelExtractor {
@Override @Override
public List<ListLinkHandler> getTabs() throws ParsingException { public List<ListLinkHandler> getTabs() throws ParsingException {
return Collections.singletonList(new ReadyChannelTabListLinkHandler(getUrl(), getId(), return Collections.singletonList(new ReadyChannelTabListLinkHandler(getUrl(), getId(),
ChannelTabs.VIDEOS, this::buildEventsTabExtractor)); ChannelTabs.VIDEOS, new VideoTabExtractorBuilder(conferenceData)));
} }
@Override @Override
@ -104,30 +104,51 @@ public class MediaCCCConferenceExtractor extends ChannelExtractor {
return conferenceData.getString("title"); return conferenceData.getString("title");
} }
private ChannelTabExtractor buildEventsTabExtractor(final StreamingService service, private static class VideoTabExtractorBuilder
final ListLinkHandler linkHandler) { implements ReadyChannelTabListLinkHandler.ChannelTabExtractorBuilder {
return new ChannelTabExtractor(service, linkHandler) { private final JsonObject conferenceData;
@Nonnull
@Override
public InfoItemsPage<InfoItem> getInitialPage() {
final MultiInfoItemsCollector collector =
new MultiInfoItemsCollector(getServiceId());
final JsonArray events = conferenceData.getArray("events");
for (int i = 0; i < events.size(); i++) {
collector.commit(new MediaCCCStreamInfoItemExtractor(events.getObject(i)));
}
return new InfoItemsPage<>(collector, null);
}
@Override VideoTabExtractorBuilder(final JsonObject conferenceData) {
public InfoItemsPage<InfoItem> getPage(final Page page) { this.conferenceData = conferenceData;
return InfoItemsPage.emptyPage(); }
}
@Override @Override
public void onFetchPage(@Nonnull final Downloader downloader) { public ChannelTabExtractor build(final StreamingService service,
// nothing to do here, as data was already fetched final ListLinkHandler linkHandler) {
return new VideoTabExtractor(service, linkHandler, conferenceData);
}
}
private static class VideoTabExtractor extends ChannelTabExtractor {
private final JsonObject conferenceData;
VideoTabExtractor(final StreamingService service,
final ListLinkHandler linkHandler,
final JsonObject conferenceData) {
super(service, linkHandler);
this.conferenceData = conferenceData;
}
@Override
public void onFetchPage(@Nonnull final Downloader downloader) {
// nothing to do here, as data was already fetched
}
@Nonnull
@Override
public InfoItemsPage<InfoItem> getInitialPage() {
final MultiInfoItemsCollector collector =
new MultiInfoItemsCollector(getServiceId());
final JsonArray events = conferenceData.getArray("events");
for (int i = 0; i < events.size(); i++) {
collector.commit(new MediaCCCStreamInfoItemExtractor(events.getObject(i)));
} }
}; return new InfoItemsPage<>(collector, null);
}
@Override
public InfoItemsPage<InfoItem> getPage(final Page page) {
return InfoItemsPage.emptyPage();
}
} }
} }

View File

@ -12,6 +12,7 @@ import com.grack.nanojson.JsonObject;
import org.schabi.newpipe.extractor.StreamingService; import org.schabi.newpipe.extractor.StreamingService;
import org.schabi.newpipe.extractor.channel.ChannelExtractor; import org.schabi.newpipe.extractor.channel.ChannelExtractor;
import org.schabi.newpipe.extractor.channel.ChannelTabExtractor;
import org.schabi.newpipe.extractor.downloader.Downloader; import org.schabi.newpipe.extractor.downloader.Downloader;
import org.schabi.newpipe.extractor.exceptions.ExtractionException; import org.schabi.newpipe.extractor.exceptions.ExtractionException;
import org.schabi.newpipe.extractor.exceptions.ParsingException; import org.schabi.newpipe.extractor.exceptions.ParsingException;
@ -249,8 +250,7 @@ public class YoutubeChannelExtractor extends ChannelExtractor {
final String url = getUrl(); final String url = getUrl();
tabs.add(0, new ReadyChannelTabListLinkHandler(tabUrl, tabs.add(0, new ReadyChannelTabListLinkHandler(tabUrl,
redirectedChannelId, ChannelTabs.VIDEOS, redirectedChannelId, ChannelTabs.VIDEOS,
(service, linkHandler) -> new YoutubeChannelVideosTabExtractor( new VideoTabExtractorBuilder(name, url, tabRenderer)));
service, linkHandler, tabRenderer, name, url)));
break; break;
case "playlists": case "playlists":
addTab.accept(ChannelTabs.PLAYLISTS); addTab.accept(ChannelTabs.PLAYLISTS);
@ -280,4 +280,25 @@ public class YoutubeChannelExtractor extends ChannelExtractor {
return tags.stream().map(Object::toString).collect(Collectors.toList()); return tags.stream().map(Object::toString).collect(Collectors.toList());
} }
private static class VideoTabExtractorBuilder
implements ReadyChannelTabListLinkHandler.ChannelTabExtractorBuilder {
private final String channelName;
private final String channelUrl;
private final JsonObject tabRenderer;
VideoTabExtractorBuilder(final String channelName, final String channelUrl,
final JsonObject tabRenderer) {
this.channelName = channelName;
this.channelUrl = channelUrl;
this.tabRenderer = tabRenderer;
}
@Override
public ChannelTabExtractor build(final StreamingService service,
final ListLinkHandler linkHandler) {
return new YoutubeChannelVideosTabExtractor(
service, linkHandler, tabRenderer, channelName, channelUrl);
}
}
} }

View File

@ -67,11 +67,10 @@ public class BandcampChannelExtractorTest implements BaseChannelExtractorTest {
public void testTabs() throws Exception { public void testTabs() throws Exception {
Set<String> tabs = extractor.getTabs().stream() Set<String> tabs = extractor.getTabs().stream()
.map(linkHandler -> linkHandler.getContentFilters().get(0)).collect(Collectors.toSet()); .map(linkHandler -> linkHandler.getContentFilters().get(0)).collect(Collectors.toSet());
assertTrue(tabs.contains(ChannelTabs.TRACKS)); assertTrue(tabs.contains(ChannelTabs.ALBUMS), "albums");
assertTrue(tabs.contains(ChannelTabs.ALBUMS));
} }
@Override @Test
public void testRelatedItems() throws Exception { public void testRelatedItems() throws Exception {
defaultTestRelatedItems(tabExtractor); defaultTestRelatedItems(tabExtractor);
} }