Add YouTube PO token & IP rotation

pom.xml

@@ -45,22 +45,26 @@
             <version>4.4.1_353</version>
         </dependency>
         <dependency>
-            <groupId>com.jagrosh</groupId>
-            <artifactId>jda-utilities</artifactId>
-            <version>3.0.5</version>
-            <type>pom</type>
+            <groupId>com.github.JDA-Applications</groupId>
+            <artifactId>JDA-Utilities</artifactId>
+            <version>c16a4b264b</version>
         </dependency>
 
         <!-- Music Dependencies -->
         <dependency>
             <groupId>dev.arbjerg</groupId>
             <artifactId>lavaplayer</artifactId>
-            <version>2.2.1</version>
+            <version>2.2.2</version>
+        </dependency>
+        <dependency>
+            <groupId>dev.arbjerg</groupId>
+            <artifactId>lavaplayer-ext-youtube-rotator</artifactId>
+            <version>2.2.2</version>
         </dependency>
         <dependency>
             <groupId>dev.lavalink.youtube</groupId>
             <artifactId>common</artifactId>
-            <version>1.5.2</version>
+            <version>1.8.3</version>
         </dependency>
 	<dependency>
 	    <groupId>com.github.jagrosh</groupId>

src/main/java/com/jagrosh/jmusicbot/Bot.java

@@ -56,7 +56,7 @@ public Bot(EventWaiter waiter, BotConfig config, SettingsManager settings)
         this.settings = settings;
         this.playlists = new PlaylistLoader(config);
         this.threadpool = Executors.newSingleThreadScheduledExecutor();
-        this.players = new PlayerManager(this);
+        this.players = new PlayerManager(this, config);
         this.players.init();
         this.nowplaying = new NowplayingHandler(this);
         this.nowplaying.init();

src/main/java/com/jagrosh/jmusicbot/BotConfig.java

@@ -18,11 +18,16 @@
 import com.jagrosh.jmusicbot.entities.Prompt;
 import com.jagrosh.jmusicbot.utils.OtherUtil;
 import com.jagrosh.jmusicbot.utils.TimeUtil;
+import com.jagrosh.jmusicbot.utils.YouTubeUtil;
 import com.sedmelluq.discord.lavaplayer.track.AudioTrack;
+import com.sedmelluq.lava.extensions.youtuberotator.tools.ip.IpBlock;
 import com.typesafe.config.*;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.List;
+import java.util.stream.Collectors;
+
 import net.dv8tion.jda.api.OnlineStatus;
 import net.dv8tion.jda.api.entities.Activity;
 
@@ -41,7 +46,9 @@ public class BotConfig
     private Path path = null;
     private String token, prefix, altprefix, helpWord, playlistsFolder, logLevel,
             successEmoji, warningEmoji, errorEmoji, loadingEmoji, searchingEmoji,
-            evalEngine;
+            ytPoToken, ytVisitorData, evalEngine;
+    private YouTubeUtil.RoutingPlanner ytRoutingPlanner;
+    private List<IpBlock> ytIpBlocks;
     private boolean stayInChannel, songInGame, npImages, updatealerts, useEval, dbots;
     private long owner, maxSeconds, aloneTimeUntilStop;
     private int maxYTPlaylistPages;
@@ -96,6 +103,10 @@ public void load()
             aloneTimeUntilStop = config.getLong("alonetimeuntilstop");
             playlistsFolder = config.getString("playlistsfolder");
             aliases = config.getConfig("aliases");
+            ytPoToken = config.getString("ytpotoken");
+            ytVisitorData = config.getString("ytvisitordata");
+            ytRoutingPlanner = config.getEnum(YouTubeUtil.RoutingPlanner.class, "ytroutingplanner");
+            ytIpBlocks = config.getStringList("ytipblocks").stream().map(YouTubeUtil::parseIpBlock).collect(Collectors.toList());
             transforms = config.getConfig("transforms");
             skipratio = config.getDouble("skipratio");
             dbots = owner == 113156185389092864L;
@@ -323,6 +334,26 @@ public String getLogLevel()
         return logLevel;
     }
 
+    public String getYTPoToken()
+    {
+        return ytPoToken.equals("PO_TOKEN_HERE") ? null : ytPoToken;
+    }
+
+    public String getYTVisitorData()
+    {
+        return ytVisitorData.equals("VISITOR_DATA_HERE") ? null : ytVisitorData;
+    }
+
+    public YouTubeUtil.RoutingPlanner getYTRoutingPlanner()
+    {
+        return ytRoutingPlanner;
+    }
+
+    public List<IpBlock> getYTIpBlocks()
+    {
+        return ytIpBlocks;
+    }
+
     public boolean useEval()
     {
         return useEval;

src/main/java/com/jagrosh/jmusicbot/audio/PlayerManager.java

@@ -17,6 +17,8 @@
 
 import com.dunctebot.sourcemanagers.DuncteBotSources;
 import com.jagrosh.jmusicbot.Bot;
+import com.jagrosh.jmusicbot.BotConfig;
+import com.jagrosh.jmusicbot.utils.YouTubeUtil;
 import com.sedmelluq.discord.lavaplayer.container.MediaContainerRegistry;
 import com.sedmelluq.discord.lavaplayer.player.AudioPlayer;
 import com.sedmelluq.discord.lavaplayer.player.DefaultAudioPlayerManager;
@@ -29,7 +31,15 @@
 import com.sedmelluq.discord.lavaplayer.source.soundcloud.SoundCloudAudioSourceManager;
 import com.sedmelluq.discord.lavaplayer.source.twitch.TwitchStreamAudioSourceManager;
 import com.sedmelluq.discord.lavaplayer.source.vimeo.VimeoAudioSourceManager;
+import com.sedmelluq.lava.extensions.youtuberotator.YoutubeIpRotatorSetup;
+import com.sedmelluq.lava.extensions.youtuberotator.planner.AbstractRoutePlanner;
+import com.sedmelluq.lava.extensions.youtuberotator.planner.BalancingIpRoutePlanner;
+import com.sedmelluq.lava.extensions.youtuberotator.planner.NanoIpRoutePlanner;
+import com.sedmelluq.lava.extensions.youtuberotator.tools.ip.IpBlock;
+import com.sedmelluq.lava.extensions.youtuberotator.tools.ip.Ipv4Block;
+import com.sedmelluq.lava.extensions.youtuberotator.tools.ip.Ipv6Block;
 import dev.lavalink.youtube.YoutubeAudioSourceManager;
+import dev.lavalink.youtube.clients.Web;
 import net.dv8tion.jda.api.entities.Guild;
 
 /**
@@ -39,17 +49,32 @@
 public class PlayerManager extends DefaultAudioPlayerManager
 {
     private final Bot bot;
-
-    public PlayerManager(Bot bot)
+    private final BotConfig config;
+
+    public PlayerManager(Bot bot, BotConfig config)
     {
         this.bot = bot;
+        this.config = config;
     }
 
     public void init()
     {
         TransformativeAudioSourceManager.createTransforms(bot.getConfig().getTransforms()).forEach(t -> registerSourceManager(t));
 
+        if (config.getYTPoToken() != null && config.getYTVisitorData() != null)
+            Web.setPoTokenAndVisitorData(config.getYTPoToken(), config.getYTVisitorData());
+
         YoutubeAudioSourceManager yt = new YoutubeAudioSourceManager(true);
+        if (config.getYTRoutingPlanner() != YouTubeUtil.RoutingPlanner.NONE)
+        {
+            AbstractRoutePlanner routePlanner = YouTubeUtil.createRouterPlanner(config.getYTRoutingPlanner(), config.getYTIpBlocks());
+            YoutubeIpRotatorSetup rotator = new YoutubeIpRotatorSetup(routePlanner);
+
+            rotator.forConfiguration(yt.getHttpInterfaceManager(), false)
+                    .withMainDelegateFilter(yt.getContextFilter())
+                    .setup();
+        }
+
         yt.setPlaylistPageCount(bot.getConfig().getMaxYTPlaylistPages());
         registerSourceManager(yt);
 

src/main/java/com/jagrosh/jmusicbot/utils/YouTubeUtil.java

@@ -0,0 +1,46 @@
+package com.jagrosh.jmusicbot.utils;
+
+import com.sedmelluq.lava.extensions.youtuberotator.planner.*;
+import com.sedmelluq.lava.extensions.youtuberotator.tools.ip.IpBlock;
+import com.sedmelluq.lava.extensions.youtuberotator.tools.ip.Ipv4Block;
+import com.sedmelluq.lava.extensions.youtuberotator.tools.ip.Ipv6Block;
+
+import java.util.List;
+
+public class YouTubeUtil {
+    public enum RoutingPlanner {
+        NONE,
+        ROTATE_ON_BAN,
+        LOAD_BALANCE,
+        NANO_SWITCH,
+        ROTATING_NANO_SWITCH
+    }
+
+    public static IpBlock parseIpBlock(String cidr) {
+        if (Ipv6Block.isIpv6CidrBlock(cidr))
+            return new Ipv6Block(cidr);
+
+        if (Ipv4Block.isIpv4CidrBlock(cidr))
+            return new Ipv4Block(cidr);
+
+        throw new IllegalArgumentException("Could not parse CIDR " + cidr);
+    }
+
+    public static AbstractRoutePlanner createRouterPlanner(RoutingPlanner routingPlanner, List<IpBlock> ipBlocks) {
+
+        switch (routingPlanner) {
+            case NONE:
+                return null;
+            case ROTATE_ON_BAN:
+                return new RotatingIpRoutePlanner(ipBlocks);
+            case LOAD_BALANCE:
+                return new BalancingIpRoutePlanner(ipBlocks);
+            case NANO_SWITCH:
+                return new NanoIpRoutePlanner(ipBlocks, true);
+            case ROTATING_NANO_SWITCH:
+                return new RotatingNanoIpRoutePlanner(ipBlocks);
+            default:
+                throw new IllegalArgumentException("Unknown RoutingPlanner value provided");
+        }
+    }
+}

src/main/resources/reference.conf

@@ -200,6 +200,34 @@ aliases {
 loglevel = info
 
 
+// This sets the "Proof of Origin Token" and visitor data to use when playing back YouTube videos.
+// It is recommend to obtain a PO token to avoid getting IP banned from YouTube.
+
+ytpotoken = "PO_TOKEN_HERE"
+ytvisitordata = "VISITOR_DATA_HERE"
+
+
+// This configures the routing planner to use for IP rotation on YouTube.
+// When set, you need to also set an IP block below.
+// The following routing strategies are available:
+// NONE = Disable
+// ROTATE_ON_BAN = Switch IP when currently used address gets banned.
+// LOAD_BALANCE = Selects random IP for each track playback.
+// NANO_SWITCH = Selects IPv6 address based on current nanosecond. Recommended for one /64 IPv6 blocks.
+// ROTATING_NANO_SWITCH = Same as above, but uses the next /64 IPv6 block in the list in case of a ban.
+
+ytroutingplanner = NONE
+
+
+// The IPv4 and IPv6 blocks to use when using the above routing planner.
+// This does nothing when ytroutingplanner is set to none.
+// The list accepts a list of IPv4 or IPv6 CIDR blocks (not a mix of them however)
+// IPv4 example: [ "192.0.2.183", "198.51.100.153/29" ]
+// IPv6 example: [ "2a02:1234:5678:9abc::/64" ]
+
+ytipblocks = [  ]
+
+
 // Transforms are used to modify specific play inputs and convert them to different kinds of inputs
 // These are quite complicated to use, and have limited use-cases, but in theory allow for rough
 // whitelists or blacklists, roundabout loading from some sources, and customization of how things are