-
Notifications
You must be signed in to change notification settings - Fork 425
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[YouTube] Support handles and all channel usernames #964
Merged
AudricV
merged 4 commits into
TeamNewPipe:dev
from
AudricV:yt-support-handles-and-all-channel-usernames
Nov 4, 2022
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
61ce041
[YouTube] Support handles and all custom channel names
AudricV 724f669
[YouTube] Add tests for handles and user IDs with non ASCII character…
AudricV a34f060
[YouTube] Use a handle for YoutubeChannelExtractorTest.Gronkh
AudricV 20cd8e8
[YouTube] Update mocks of YoutubeChannelExtractorTest.Gronkh
AudricV File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,46 @@ | ||
package org.schabi.newpipe.extractor.services.youtube.linkHandler; | ||
|
||
import java.util.regex.Pattern; | ||
import org.schabi.newpipe.extractor.exceptions.ParsingException; | ||
import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory; | ||
import org.schabi.newpipe.extractor.services.youtube.YoutubeParsingHelper; | ||
import org.schabi.newpipe.extractor.utils.Utils; | ||
|
||
import java.net.URL; | ||
import java.util.List; | ||
|
||
/* | ||
* Created by Christian Schabesberger on 25.07.16. | ||
* | ||
* Copyright (C) Christian Schabesberger 2018 <chrź[email protected]> | ||
* YoutubeChannelLinkHandlerFactory.java is part of NewPipe. | ||
* YoutubeChannelLinkHandlerFactory.java is part of NewPipe Extractor. | ||
* | ||
* NewPipe is free software: you can redistribute it and/or modify | ||
* NewPipe Extractor is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU General Public License as published by | ||
* the Free Software Foundation, either version 3 of the License, or | ||
* (at your option) any later version. | ||
* | ||
* NewPipe is distributed in the hope that it will be useful, | ||
* NewPipe Extractor is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU General Public License | ||
* along with NewPipe. If not, see <http://www.gnu.org/licenses/>. | ||
* along with NewPipe Extractor. If not, see <https://www.gnu.org/licenses/>. | ||
*/ | ||
|
||
package org.schabi.newpipe.extractor.services.youtube.linkHandler; | ||
|
||
import java.util.regex.Pattern; | ||
import org.schabi.newpipe.extractor.exceptions.ParsingException; | ||
import org.schabi.newpipe.extractor.linkhandler.ListLinkHandlerFactory; | ||
import org.schabi.newpipe.extractor.services.youtube.YoutubeParsingHelper; | ||
import org.schabi.newpipe.extractor.utils.Utils; | ||
|
||
import javax.annotation.Nonnull; | ||
import java.net.URL; | ||
import java.util.List; | ||
|
||
import static org.schabi.newpipe.extractor.utils.Utils.isBlank; | ||
|
||
public final class YoutubeChannelLinkHandlerFactory extends ListLinkHandlerFactory { | ||
|
||
private static final YoutubeChannelLinkHandlerFactory INSTANCE | ||
= new YoutubeChannelLinkHandlerFactory(); | ||
|
||
private static final Pattern EXCLUDED_SEGMENTS = | ||
Pattern.compile("playlist|watch|attribution_link|watch_popup|embed|feed|select_site"); | ||
private static final Pattern EXCLUDED_SEGMENTS = Pattern.compile( | ||
// CHECKSTYLE:OFF | ||
"playlist|watch|attribution_link|watch_popup|embed|feed|select_site|account|reporthistory|redirect"); | ||
// CHECKSTYLE:ON | ||
|
||
private YoutubeChannelLinkHandlerFactory() { | ||
} | ||
|
@@ -45,10 +50,10 @@ public static YoutubeChannelLinkHandlerFactory getInstance() { | |
} | ||
|
||
/** | ||
* Returns URL to channel from an ID | ||
* Returns the URL to a channel from an ID. | ||
* | ||
* @param id Channel ID including e.g. 'channel/' | ||
* @return URL to channel | ||
* @param id the channel ID including e.g. 'channel/' | ||
* @return the URL to the channel | ||
*/ | ||
@Override | ||
public String getUrl(final String id, | ||
|
@@ -58,16 +63,26 @@ public String getUrl(final String id, | |
} | ||
|
||
/** | ||
* Returns true if path conform to | ||
* custom short channel URLs like youtube.com/yourcustomname | ||
* Checks whether the given path conforms to custom short channel URLs like | ||
* {@code youtube.com/yourcustomname}. | ||
* | ||
* @param splitPath path segments array | ||
* @return true - if value conform to short channel URL, false - not | ||
* @param splitPath the path segments array | ||
* @return whether the value conform to short channel URLs | ||
*/ | ||
private boolean isCustomShortChannelUrl(final String[] splitPath) { | ||
private boolean isCustomShortChannelUrl(@Nonnull final String[] splitPath) { | ||
return splitPath.length == 1 && !EXCLUDED_SEGMENTS.matcher(splitPath[0]).matches(); | ||
} | ||
|
||
/** | ||
* Checks whether the given path conforms to handle URLs like {@code youtube.com/@yourhandle}. | ||
* | ||
* @param splitPath the path segments array | ||
* @return whether the value conform to handle URLs | ||
*/ | ||
private boolean isHandle(@Nonnull final String[] splitPath) { | ||
return splitPath.length > 0 && splitPath[0].startsWith("@"); | ||
} | ||
|
||
@Override | ||
public String getId(final String url) throws ParsingException { | ||
try { | ||
|
@@ -77,35 +92,38 @@ public String getId(final String url) throws ParsingException { | |
if (!Utils.isHTTP(urlObj) || !(YoutubeParsingHelper.isYoutubeURL(urlObj) | ||
|| YoutubeParsingHelper.isInvidioURL(urlObj) | ||
|| YoutubeParsingHelper.isHooktubeURL(urlObj))) { | ||
throw new ParsingException("the URL given is not a Youtube-URL"); | ||
throw new ParsingException("The URL given is not a YouTube URL"); | ||
} | ||
|
||
// remove leading "/" | ||
// Remove leading "/" | ||
path = path.substring(1); | ||
|
||
String[] splitPath = path.split("/"); | ||
|
||
// Handle custom short channel URLs like youtube.com/yourcustomname | ||
if (isCustomShortChannelUrl(splitPath)) { | ||
if (isHandle(splitPath)) { | ||
// Handle YouTube handle URLs like youtube.com/@yourhandle | ||
return splitPath[0]; | ||
} else if (isCustomShortChannelUrl(splitPath)) { | ||
// Handle custom short channel URLs like youtube.com/yourcustomname | ||
path = "c/" + path; | ||
splitPath = path.split("/"); | ||
} | ||
|
||
if (!path.startsWith("user/") | ||
&& !path.startsWith("channel/") | ||
if (!path.startsWith("user/") && !path.startsWith("channel/") | ||
&& !path.startsWith("c/")) { | ||
throw new ParsingException("the URL given is neither a channel nor an user"); | ||
throw new ParsingException( | ||
"The given URL is not a channel, a user or a handle URL"); | ||
} | ||
|
||
final String id = splitPath[1]; | ||
|
||
if (id == null || !id.matches("[A-Za-z0-9_-]+")) { | ||
throw new ParsingException("The given id is not a Youtube-Video-ID"); | ||
if (isBlank(id)) { | ||
throw new ParsingException("The given ID is not a YouTube channel or user ID"); | ||
} | ||
|
||
return splitPath[0] + "/" + id; | ||
} catch (final Exception exception) { | ||
throw new ParsingException("Error could not parse url :" + exception.getMessage(), | ||
exception); | ||
} catch (final Exception e) { | ||
throw new ParsingException("Could not parse URL :" + e.getMessage(), e); | ||
} | ||
} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 5 additions & 5 deletions
10
.../schabi/newpipe/extractor/services/youtube/extractor/channel/gronkh/generated_mock_1.json
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 4 additions & 4 deletions
8
.../schabi/newpipe/extractor/services/youtube/extractor/channel/gronkh/generated_mock_3.json
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think we should use something else to match all custom names of channels or not?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to have a channel ID that does not match the old pattern, e.g. by consisting of non latin characters?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok. dumb question. you put one into your tests... https://www.youtube.com/c/%EB%85%B8%EB%A7%88%EB%93%9C%EC%BD%94%EB%8D%94NomadCoders