Merge pull request #313 from Royosef/DisplayParentChannelDetails

wb9688 · web-flow · commit 44d382b4bd73 · 2020-05-08T15:52:32.000+02:00
Display parent channel details
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/channel/ChannelExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/channel/ChannelExtractor.java
@@ -37,4 +37,7 @@ public ChannelExtractor(StreamingService service, ListLinkHandler linkHandler) {
     public abstract String getFeedUrl() throws ParsingException;
     public abstract long getSubscriberCount() throws ParsingException;
     public abstract String getDescription() throws ParsingException;
+    public abstract String getSubChannelName() throws ParsingException;
+    public abstract String getSubChannelUrl() throws ParsingException;
+    public abstract String getSubChannelAvatarUrl() throws ParsingException;
 }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/channel/ChannelInfo.java b/extractor/src/main/java/org/schabi/newpipe/extractor/channel/ChannelInfo.java
@@ -94,16 +94,61 @@ public static ChannelInfo getInfo(ChannelExtractor extractor) throws IOException
             info.addError(e);
         }
 
+        try {
+            info.setSubChannelName(extractor.getSubChannelName());
+        } catch (Exception e) {
+            info.addError(e);
+        }
+
+        try {
+            info.setSubChannelUrl(extractor.getSubChannelUrl());
+        } catch (Exception e) {
+            info.addError(e);
+        }
+
+        try {
+            info.setSubChannelAvatarUrl(extractor.getSubChannelAvatarUrl());
+        } catch (Exception e) {
+            info.addError(e);
+        }
+
         return info;
     }
 
     private String avatarUrl;
+    private String subChannelName;
+    private String subChannelUrl;
+    private String subChannelAvatarUrl;
     private String bannerUrl;
     private String feedUrl;
     private long subscriberCount = -1;
     private String description;
     private String[] donationLinks;
 
+    public String getSubChannelName() {
+        return subChannelName;
+    }
+
+    public void setSubChannelName(String subChannelName) {
+        this.subChannelName = subChannelName;
+    }
+
+    public String getSubChannelUrl() {
+        return subChannelUrl;
+    }
+
+    public void setSubChannelUrl(String subChannelUrl) {
+        this.subChannelUrl = subChannelUrl;
+    }
+
+    public String getSubChannelAvatarUrl() {
+        return subChannelAvatarUrl;
+    }
+
+    public void setSubChannelAvatarUrl(String subChannelAvatarUrl) {
+        this.subChannelAvatarUrl = subChannelAvatarUrl;
+    }
+
     public String getAvatarUrl() {
         return avatarUrl;
     }
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCConferenceExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCConferenceExtractor.java
@@ -52,6 +52,21 @@ public String getDescription() {
         return null;
     }
 
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        return "";
+    }
+
     @Nonnull
     @Override
     public InfoItemsPage<StreamInfoItem> getInitialPage() {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCStreamExtractor.java
@@ -112,7 +112,25 @@ public String getUploaderAvatarUrl() {
 
     @Nonnull
     @Override
-    public String getDashMpdUrl() {
+    public String getSubChannelUrl() throws ParsingException {
+        return "";
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return "";
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        return "";
+    }
+
+    @Nonnull
+    @Override
+    public String getDashMpdUrl() throws ParsingException {
         return "";
     }
 
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeAccountExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeAccountExtractor.java
@@ -75,6 +75,21 @@ public String getDescription() throws ParsingException {
         }
     }
 
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        return "";
+    }
+
     @Override
     public InfoItemsPage<StreamInfoItem> getInitialPage() throws IOException, ExtractionException {
         super.fetchPage();
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeChannelExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeChannelExtractor.java
@@ -75,6 +75,27 @@ public String getDescription() throws ParsingException {
         }
     }
 
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return JsonUtils.getString(json, "ownerAccount.name");
+    }
+
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return JsonUtils.getString(json, "ownerAccount.url");
+    }
+
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        String value;
+        try {
+            value = JsonUtils.getString(json, "ownerAccount.avatar.path");
+        } catch (Exception e) {
+            value = "/client/assets/images/default-avatar.png";
+        }
+        return baseUrl + value;
+    }
+
     @Override
     public InfoItemsPage<StreamInfoItem> getInitialPage() throws IOException, ExtractionException {
         super.fetchPage();
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeStreamExtractor.java
@@ -147,6 +147,29 @@ public String getUploaderAvatarUrl() throws ParsingException {
         return baseUrl + value;
     }
 
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return JsonUtils.getString(json, "channel.url");
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return JsonUtils.getString(json, "channel.displayName");
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        String value;
+        try {
+            value = JsonUtils.getString(json, "channel.avatar.path");
+        } catch (Exception e) {
+            value = "/client/assets/images/default-avatar.png";
+        }
+        return baseUrl + value;
+    }
+
     @Override
     public String getDashMpdUrl() throws ParsingException {
         return "";
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudChannelExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudChannelExtractor.java
@@ -83,6 +83,21 @@ public String getDescription() {
         return user.getString("description", EMPTY_STRING);
     }
 
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        return "";
+    }
+
     @Nonnull
     @Override
     public InfoItemsPage<StreamInfoItem> getInitialPage() throws ExtractionException {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudStreamExtractor.java
@@ -142,6 +142,24 @@ public String getUploaderAvatarUrl() {
         return SoundcloudParsingHelper.getAvatarUrl(track);
     }
 
+    @Nonnull
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return "";
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return "";
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        return "";
+    }
+
     @Nonnull
     @Override
     public String getDashMpdUrl() {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeChannelExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeChannelExtractor.java
@@ -212,6 +212,21 @@ public String getDescription() throws ParsingException {
         }
     }
 
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return "";
+    }
+
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        return "";
+    }
+
     @Nonnull
     @Override
     public InfoItemsPage<StreamInfoItem> getInitialPage() throws ExtractionException {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
@@ -352,6 +352,24 @@ public String getUploaderAvatarUrl() throws ParsingException {
         }
     }
 
+    @Nonnull
+    @Override
+    public String getSubChannelUrl() throws ParsingException {
+        return "";
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelName() throws ParsingException {
+        return "";
+    }
+
+    @Nonnull
+    @Override
+    public String getSubChannelAvatarUrl() throws ParsingException {
+        return "";
+    }
+
     @Nonnull
     @Override
     public String getDashMpdUrl() throws ParsingException {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java
@@ -23,6 +23,7 @@
 import org.schabi.newpipe.extractor.Extractor;
 import org.schabi.newpipe.extractor.MediaFormat;
 import org.schabi.newpipe.extractor.StreamingService;
+import org.schabi.newpipe.extractor.channel.ChannelExtractor;
 import org.schabi.newpipe.extractor.exceptions.ExtractionException;
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.LinkHandler;
@@ -148,7 +149,7 @@ public StreamExtractor(StreamingService service, LinkHandler linkHandler) {
     /**
      * The Url to the page of the creator/uploader of the stream. This must not be a homepage,
      * but the page offered by the service the extractor handles. This url will be handled by the
-     * <a href="https://teamnewpipe.github.io/documentation/03_Implement_a_service/#channel">ChannelExtractor</a>,
+     * {@link ChannelExtractor},
      * so be sure to implement that one before you return a value here, otherwise NewPipe will crash if one selects
      * this url.
      *
@@ -178,6 +179,39 @@ public StreamExtractor(StreamingService service, LinkHandler linkHandler) {
     @Nonnull
     public abstract String getUploaderAvatarUrl() throws ParsingException;
 
+    /**
+     * The Url to the page of the sub-channel of the stream. This must not be a homepage,
+     * but the page offered by the service the extractor handles. This url will be handled by the
+     * {@link ChannelExtractor},
+     * so be sure to implement that one before you return a value here, otherwise NewPipe will crash if one selects
+     * this url.
+     *
+     * @return the url to the page of the sub-channel of the stream or an empty String
+     * @throws ParsingException
+     */
+    @Nonnull
+    public abstract String getSubChannelUrl() throws ParsingException;
+
+    /**
+     * The name of the sub-channel of the stream.
+     * If the name is not available you can simply return an empty string.
+     *
+     * @return the name of the sub-channel of the stream or an empty String
+     * @throws ParsingException
+     */
+    @Nonnull
+    public abstract String getSubChannelName() throws ParsingException;
+
+    /**
+     * The url to the image file/profile picture/avatar of the sub-channel of the stream.
+     * If the url is not available you can return an empty String.
+     *
+     * @return The url of the image file of the sub-channel or an empty String
+     * @throws ParsingException
+     */
+    @Nonnull
+    public abstract String getSubChannelAvatarUrl() throws ParsingException;
+
     /**
      * Get the dash mpd url. If you don't know what a dash MPD is you can read about it
      * <a href="https://www.brendanlong.com/the-structure-of-an-mpeg-dash-mpd.html">here</a>.
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfo.java b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfo.java
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/peertube/PeertubeChannelExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/peertube/PeertubeChannelExtractorTest.java
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/peertube/PeertubeStreamExtractorDefaultTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/peertube/PeertubeStreamExtractorDefaultTest.java

Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,7 @@ public ChannelExtractor(StreamingService service, ListLinkHandler linkHandler) {`
`37`	`37`	`public abstract String getFeedUrl() throws ParsingException;`
`38`	`38`	`public abstract long getSubscriberCount() throws ParsingException;`
`39`	`39`	`public abstract String getDescription() throws ParsingException;`
	`40`	`+ public abstract String getSubChannelName() throws ParsingException;`
	`41`	`+ public abstract String getSubChannelUrl() throws ParsingException;`
	`42`	`+ public abstract String getSubChannelAvatarUrl() throws ParsingException;`
`40`	`43`	`}`