update reference.conf

add transformative audio source
fix intents

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Community Support Server
-    url: https://discord.gg/0p9LSGoRLu6Pet0k
-    about: For general questions, please ask in the support server
+  - name: Question
+    url: https://github.com/jagrosh/MusicBot/discussions/categories/questions
+    about: For general questions, please check the Discussions

.github/ISSUE_TEMPLATE/feature-request.md

@@ -22,5 +22,6 @@ How this feature would be used:
 **Additional context**
 Add any other context or screenshots about the feature request here.
 
-**Have you confirmed that this idea is not already described here?**
-https://github.com/jagrosh/MusicBot/projects/1
+**Please check the following links to confirm that your feature has not already been requested:**
+https://github.com/jagrosh/MusicBot/labels/enhancement
+https://github.com/jagrosh/MusicBot/wiki/Things-That-Won%27t-Be-Added

README.md

@@ -22,7 +22,6 @@ A cross-platform Discord music bot with a clean interface, and that is easy to s
   * Smooth playback
   * Server-specific setup for the "DJ" role that can moderate the music
   * Clean and beautiful menus
-  * Channel-topic playback bar
   * Supports many sites, including Youtube, Soundcloud, and more
   * Supports many online radio/streams
   * Supports local files
@@ -35,7 +34,7 @@ A cross-platform Discord music bot with a clean interface, and that is easy to s
 Please see the [Setup Page](https://github.com/jagrosh/MusicBot/wiki/Setup) in the wiki to run this bot yourself!
 
 ## Questions/Suggestions/Bug Reports
-**Please read the [Suggested/Planned Features List](https://github.com/jagrosh/MusicBot/projects/1) before suggesting a feature**. If you'd like to suggest changes to how the bot functions, recommend more customization options, or report bugs, feel free to either open an [Issue](https://github.com/jagrosh/MusicBot/issues) on this repository, or join [my Discord server](https://discord.gg/0p9LSGoRLu6Pet0k). (Note: I will not accept any feature requests that will require additional API keys, nor any non-music features). If you like this bot, be sure to add a star to the libraries that make this possible: [**JDA**](https://github.com/DV8FromTheWorld/JDA) and [**lavaplayer**](https://github.com/sedmelluq/lavaplayer)
+**Please read the [Issues List](https://github.com/jagrosh/MusicBot/issues) before suggesting a feature**. If you have a question, need troubleshooting help, or want to brainstorm a new feature, please start a [Discussion](https://github.com/jagrosh/MusicBot/discussions). If you'd like to suggest a feature or report a reproducible bug, please open an [Issue](https://github.com/jagrosh/MusicBot/issues) on this repository. If you like this bot, be sure to add a star to the libraries that make this possible: [**JDA**](https://github.com/DV8FromTheWorld/JDA) and [**lavaplayer**](https://github.com/sedmelluq/lavaplayer)!
 
 ## Editing
 This bot (and the source code here) might not be easy to edit for inexperienced programmers. The main purpose of having the source public is to show the capabilities of the libraries, to allow others to understand how the bot works, and to allow those knowledgeable about java, JDA, and Discord bot development to contribute. There are many requirements and dependencies required to edit and compile it, and there will not be support provided for people looking to make changes on their own. Instead, consider making a feature request (see the above section). If you choose to make edits, please do so in accordance with the Apache 2.0 License.

pom.xml

@@ -7,6 +7,11 @@
     <packaging>jar</packaging>
     
     <repositories>
+        <repository>
+            <id>dv8tion</id>
+            <name>m2-dv8tion</name>
+            <url>https://m2.dv8tion.net/releases</url>
+        </repository>
         <repository>
             <id>central</id>
             <name>bintray</name>
@@ -23,12 +28,12 @@
         <dependency>
             <groupId>net.dv8tion</groupId> 
             <artifactId>JDA</artifactId> 
-            <version>4.2.0_214</version>
+            <version>4.3.0_312</version>
         </dependency>
         <dependency>
             <groupId>com.sedmelluq</groupId>
             <artifactId>lavaplayer</artifactId>
-            <version>1.3.55</version>
+            <version>1.3.78</version>
         </dependency>
         <dependency>
             <groupId>com.sedmelluq</groupId>
@@ -44,7 +49,7 @@
         <dependency>
             <groupId>com.jagrosh</groupId>
             <artifactId>JLyrics</artifactId>
-            <version>0.4</version>
+            <version>0.5</version>
         </dependency>
         <dependency>
             <groupId>ch.qos.logback</groupId>
@@ -56,6 +61,11 @@
             <artifactId>config</artifactId>
             <version>1.3.2</version>
         </dependency>
+        <dependency>
+            <groupId>org.jsoup</groupId>
+            <artifactId>jsoup</artifactId>
+            <version>1.14.2</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

scripts/run_jmusicbot.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+# This will have this script check for a new version of JMusicBot every
+# startup (and download it if the latest version isn't currently downloaded)
+DOWNLOAD=true
+
+# This will cause the script to run in a loop so that the bot auto-restarts
+# when you use the shutdown command
+LOOP=true
+
+download() {
+    if [ $DOWNLOAD == true ]; then
+        URL=$(curl -s https://api.github.com/repos/jagrosh/MusicBot/releases/latest \
+           | grep -i browser_download_url.*\.jar \
+           | sed 's/.*\(http.*\)"/\1/')
+        FILENAME=$(echo $URL | sed 's/.*\/\([^\/]*\)/\1/')
+        if [ -f $FILENAME ]; then
+            echo "Latest version already downloaded (${FILENAME})"
+        else
+            curl -L $URL -o $FILENAME
+        fi
+    fi
+}
+
+run() {
+    java -Dnogui=true -jar $(ls -t JMusicBot* | head -1)
+}
+
+while
+    download
+    run
+    $LOOP
+do
+    continue
+done 

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

@@ -18,6 +18,7 @@ package com.jagrosh.jmusicbot;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 import com.jagrosh.jdautilities.commons.waiter.EventWaiter;
+import com.jagrosh.jmusicbot.audio.AloneInVoiceHandler;
 import com.jagrosh.jmusicbot.audio.AudioHandler;
 import com.jagrosh.jmusicbot.audio.NowplayingHandler;
 import com.jagrosh.jmusicbot.audio.PlayerManager;
@@ -42,6 +43,7 @@ public class Bot
     private final PlayerManager players;
     private final PlaylistLoader playlists;
     private final NowplayingHandler nowplaying;
+    private final AloneInVoiceHandler aloneInVoiceHandler;
     
     private boolean shuttingDown = false;
     private JDA jda;
@@ -58,6 +60,8 @@ public class Bot
         this.players.init();
         this.nowplaying = new NowplayingHandler(this);
         this.nowplaying.init();
+        this.aloneInVoiceHandler = new AloneInVoiceHandler(this);
+        this.aloneInVoiceHandler.init();
     }
     
     public BotConfig getConfig()
@@ -94,6 +98,11 @@ public class Bot
     {
         return nowplaying;
     }
+
+    public AloneInVoiceHandler getAloneInVoiceHandler()
+    {
+        return aloneInVoiceHandler;
+    }
     
     public JDA getJDA()
     {

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

@@ -23,6 +23,7 @@ import com.typesafe.config.*;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Collections;
 import net.dv8tion.jda.api.OnlineStatus;
 import net.dv8tion.jda.api.entities.Activity;
 
@@ -42,11 +43,10 @@ public class BotConfig
     private String token, prefix, altprefix, helpWord, playlistsFolder,
             successEmoji, warningEmoji, errorEmoji, loadingEmoji, searchingEmoji;
     private boolean stayInChannel, songInGame, npImages, updatealerts, useEval, dbots;
-    private long owner, maxSeconds;
+    private long owner, maxSeconds, aloneTimeUntilStop;
     private OnlineStatus status;
     private Activity game;
-    private Config aliases;
-
+    private Config aliases, transforms;
 
     private boolean valid = false;
     
@@ -94,8 +94,10 @@ public class BotConfig
             updatealerts = config.getBoolean("updatealerts");
             useEval = config.getBoolean("eval");
             maxSeconds = config.getLong("maxtime");
+            aloneTimeUntilStop = config.getLong("alonetimeuntilstop");
             playlistsFolder = config.getString("playlistsfolder");
             aliases = config.getConfig("aliases");
+            transforms = config.getConfig("transforms");
             dbots = owner == 113156185389092864L;
             
             // we may need to write a new config file
@@ -298,6 +300,11 @@ public class BotConfig
     {
         return FormatUtil.formatTime(maxSeconds * 1000);
     }
+
+    public long getAloneTimeUntilStop()
+    {
+        return aloneTimeUntilStop;
+    }
     
     public boolean isTooLong(AudioTrack track)
     {
@@ -317,4 +324,9 @@ public class BotConfig
             return new String[0];
         }
     }
+    
+    public Config getTransforms()
+    {
+        return transforms;
+    }
 }

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

@@ -59,8 +59,7 @@ public class JMusicBot
         Logger log = LoggerFactory.getLogger("Startup");
         
         // create prompt to handle startup
-        Prompt prompt = new Prompt("JMusicBot", "Switching to nogui mode. You can manually start in nogui mode by including the -Dnogui=true flag.", 
-                "true".equalsIgnoreCase(System.getProperty("nogui", "false")));
+        Prompt prompt = new Prompt("JMusicBot", "Switching to nogui mode. You can manually start in nogui mode by including the -Dnogui=true flag.");
         
         // get and check latest version
         String version = OtherUtil.checkVersion(prompt);
@@ -173,7 +172,7 @@ public class JMusicBot
         {
             JDA jda = JDABuilder.create(config.getToken(), Arrays.asList(INTENTS))
                     .enableCache(CacheFlag.MEMBER_OVERRIDES, CacheFlag.VOICE_STATE)
-                    .disableCache(CacheFlag.ACTIVITY, CacheFlag.CLIENT_STATUS, CacheFlag.EMOTE)
+                    .disableCache(CacheFlag.ACTIVITY, CacheFlag.CLIENT_STATUS, CacheFlag.EMOTE, CacheFlag.ONLINE_STATUS)
                     .setActivity(nogame ? null : Activity.playing("loading..."))
                     .setStatus(config.getStatus()==OnlineStatus.INVISIBLE || config.getStatus()==OnlineStatus.OFFLINE 
                             ? OnlineStatus.INVISIBLE : OnlineStatus.DO_NOT_DISTURB)

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

@@ -24,8 +24,10 @@ import net.dv8tion.jda.api.entities.VoiceChannel;
 import net.dv8tion.jda.api.events.ReadyEvent;
 import net.dv8tion.jda.api.events.ShutdownEvent;
 import net.dv8tion.jda.api.events.guild.GuildJoinEvent;
+import net.dv8tion.jda.api.events.guild.voice.GuildVoiceUpdateEvent;
 import net.dv8tion.jda.api.events.message.guild.GuildMessageDeleteEvent;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -89,7 +91,13 @@ public class Listener extends ListenerAdapter
     {
         bot.getNowplayingHandler().onMessageDelete(event.getGuild(), event.getMessageIdLong());
     }
-    
+
+    @Override
+    public void onGuildVoiceUpdate(@NotNull GuildVoiceUpdateEvent event)
+    {
+        bot.getAloneInVoiceHandler().onVoiceUpdate(event);
+    }
+
     @Override
     public void onShutdown(ShutdownEvent event) 
     {

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

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2021 John Grosh <john.a.grosh@gmail.com>.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.jagrosh.jmusicbot.audio;
+
+import com.jagrosh.jmusicbot.Bot;
+import net.dv8tion.jda.api.entities.Guild;
+import net.dv8tion.jda.api.events.guild.voice.GuildVoiceUpdateEvent;
+
+import java.time.Instant;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.TimeUnit;
+
+/**
+ *
+ * @author Michaili K (mysteriouscursor+git@protonmail.com)
+ */
+public class AloneInVoiceHandler
+{
+    private final Bot bot;
+    private final HashMap<Long, Instant> aloneSince = new HashMap<>();
+    private long aloneTimeUntilStop = 0;
+
+    public AloneInVoiceHandler(Bot bot)
+    {
+        this.bot = bot;
+    }
+    
+    public void init()
+    {
+        aloneTimeUntilStop = bot.getConfig().getAloneTimeUntilStop();
+        if(aloneTimeUntilStop > 0)
+            bot.getThreadpool().scheduleWithFixedDelay(() -> check(), 0, 5, TimeUnit.SECONDS);
+    }
+    
+    private void check()
+    {
+        Set<Long> toRemove = new HashSet<>();
+        for(Map.Entry<Long, Instant> entrySet: aloneSince.entrySet())
+        {
+            if(entrySet.getValue().getEpochSecond() > Instant.now().getEpochSecond() - aloneTimeUntilStop) continue;
+
+            Guild guild = bot.getJDA().getGuildById(entrySet.getKey());
+
+            if(guild == null)
+            {
+                toRemove.add(entrySet.getKey());
+                continue;
+            }
+
+            ((AudioHandler) guild.getAudioManager().getSendingHandler()).stopAndClear();
+            guild.getAudioManager().closeAudioConnection();
+
+            toRemove.add(entrySet.getKey());
+        }
+        toRemove.forEach(id -> aloneSince.remove(id));
+    }
+
+    public void onVoiceUpdate(GuildVoiceUpdateEvent event)
+    {
+        if(aloneTimeUntilStop <= 0) return;
+
+        Guild guild = event.getEntity().getGuild();
+        if(!bot.getPlayerManager().hasHandler(guild)) return;
+
+        boolean alone = isAlone(guild);
+        boolean inList = aloneSince.containsKey(guild.getIdLong());
+
+        if(!alone && inList)
+            aloneSince.remove(guild.getIdLong());
+        else if(alone && !inList)
+            aloneSince.put(guild.getIdLong(), Instant.now());
+    }
+
+    private boolean isAlone(Guild guild)
+    {
+        if(guild.getAudioManager().getConnectedChannel() == null) return false;
+        return guild.getAudioManager().getConnectedChannel().getMembers().stream()
+                .noneMatch(x ->
+                        !x.getVoiceState().isDeafened()
+                        && !x.getUser().isBot());
+    }
+}

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

@@ -20,6 +20,7 @@ import com.sedmelluq.discord.lavaplayer.player.AudioPlayer;
 import com.sedmelluq.discord.lavaplayer.player.DefaultAudioPlayerManager;
 import com.sedmelluq.discord.lavaplayer.source.AudioSourceManagers;
 import com.sedmelluq.discord.lavaplayer.source.youtube.YoutubeAudioSourceManager;
+import com.typesafe.config.Config;
 import net.dv8tion.jda.api.entities.Guild;
 
 /**
@@ -37,6 +38,7 @@ public class PlayerManager extends DefaultAudioPlayerManager
     
     public void init()
     {
+        TransformativeAudioSourceManager.createTransforms(bot.getConfig().getTransforms()).forEach(t -> registerSourceManager(t));
         AudioSourceManagers.registerRemoteSources(this);
         AudioSourceManagers.registerLocalSource(this);
         source(YoutubeAudioSourceManager.class).setPlaylistPageCount(10);

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

@@ -0,0 +1,104 @@
+/*
+ * Copyright 2021 John Grosh <john.a.grosh@gmail.com>.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.jagrosh.jmusicbot.audio;
+
+import com.sedmelluq.discord.lavaplayer.player.AudioPlayerManager;
+import com.sedmelluq.discord.lavaplayer.source.youtube.YoutubeAudioSourceManager;
+import com.sedmelluq.discord.lavaplayer.track.AudioItem;
+import com.sedmelluq.discord.lavaplayer.track.AudioReference;
+import com.typesafe.config.Config;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+import java.util.regex.PatternSyntaxException;
+import java.util.stream.Collectors;
+import org.jsoup.Jsoup;
+import org.jsoup.nodes.Document;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ *
+ * @author John Grosh (john.a.grosh@gmail.com)
+ */
+public class TransformativeAudioSourceManager extends YoutubeAudioSourceManager
+{
+    private final static Logger log = LoggerFactory.getLogger(TransformativeAudioSourceManager.class);
+    private final String name, regex, replacement, selector, format;
+    
+    public TransformativeAudioSourceManager(String name, Config object)
+    {
+        this(name, object.getString("regex"), object.getString("replacement"), object.getString("selector"), object.getString("format"));
+    }
+    
+    public TransformativeAudioSourceManager(String name, String regex, String replacement, String selector, String format)
+    {
+        this.name = name;
+        this.regex = regex;
+        this.replacement = replacement;
+        this.selector = selector;
+        this.format = format;
+    }
+
+    @Override
+    public String getSourceName()
+    {
+        return name;
+    }
+
+    @Override
+    public AudioItem loadItem(AudioPlayerManager apm, AudioReference ar)
+    {
+        if(ar.identifier == null || !ar.identifier.matches(regex))
+            return null;
+        try
+        {
+            String url = ar.identifier.replaceAll(regex, replacement);
+            Document doc = Jsoup.connect(url).get();
+            String value = doc.selectFirst(selector).ownText();
+            String formattedValue = String.format(format, value);
+            return super.loadItem(apm, new AudioReference(formattedValue, null));
+        }
+        catch (PatternSyntaxException ex)
+        {
+            log.info(String.format("Invalid pattern syntax '%s' in source '%s'", regex, name));
+        }
+        catch (IOException ex)
+        {
+            log.warn(String.format("Failed to resolve URL in source '%s': ", name), ex);
+        }
+        catch (Exception ex)
+        {
+            log.warn(String.format("Exception in source '%s'", name), ex);
+        }
+        return null;
+    }
+    
+    public static List<TransformativeAudioSourceManager> createTransforms(Config transforms)
+    {
+        try
+        {
+            return transforms.root().entrySet().stream()
+                    .map(e -> new TransformativeAudioSourceManager(e.getKey(), transforms.getConfig(e.getKey())))
+                    .collect(Collectors.toList());
+        }
+        catch (Exception ex)
+        {
+            log.warn("Invalid transform ", ex);
+            return Collections.emptyList();
+        }
+    }
+}

src/main/java/com/jagrosh/jmusicbot/entities/Prompt.java

@@ -30,6 +30,7 @@ public class Prompt
     private final String noguiMessage;
     
     private boolean nogui;
+    private boolean noprompt;
     private Scanner scanner;
     
     public Prompt(String title)
@@ -39,14 +40,15 @@ public class Prompt
     
     public Prompt(String title, String noguiMessage)
     {
-        this(title, noguiMessage, "true".equalsIgnoreCase(System.getProperty("nogui")));
+        this(title, noguiMessage, "true".equalsIgnoreCase(System.getProperty("nogui")), "true".equalsIgnoreCase(System.getProperty("noprompt")));
     }
     
-    public Prompt(String title, String noguiMessage, boolean nogui)
+    public Prompt(String title, String noguiMessage, boolean nogui, boolean noprompt)
     {
         this.title = title;
         this.noguiMessage = noguiMessage == null ? "Switching to nogui mode. You can manually start in nogui mode by including the -Dnogui=true flag." : noguiMessage;
         this.nogui = nogui;
+        this.noprompt = noprompt;
     }
     
     public boolean isNoGUI()
@@ -108,6 +110,8 @@ public class Prompt
     
     public String prompt(String content)
     {
+        if(noprompt)
+            return null;
         if(nogui)
         {
             if(scanner==null)

src/main/resources/reference.conf

@@ -28,7 +28,6 @@ owner = 0 // OWNER ID
 // The prefix is used to control the commands
 // If you use !!, the play command will be !!play
 // If you do not set this, the prefix will be a mention of the bot (@Botname play)
-// If you make this blank, the bot will not use a prefix
 
 prefix = "@mention"
 
@@ -100,6 +99,13 @@ stayinchannel = false
 maxtime = 0
 
 
+// This sets the amount of seconds the bot will stay alone on a voice channel until it
+// automatically leaves the voice channel and clears the queue. If not set or set
+// to any number less than or equal to zero, the bot won't leave when alone.
+
+alonetimeuntilstop = 0
+
+
 // This sets an alternative folder to be used as the Playlists folder
 // This can be a relative or absolute path
 
@@ -113,7 +119,7 @@ updatealerts=true
 
 
 // Changing this changes the lyrics provider
-// Currently available providers: "A-Z Lyrics", "Genius", "MusicMatch"
+// Currently available providers: "A-Z Lyrics", "Genius", "MusicMatch", "LyricsFreak"
 // At the time of writing, I would recommend sticking with A-Z Lyrics or MusicMatch,
 // as Genius tends to have a lot of non-song results and you might get something 
 // completely unrelated to what you want.
@@ -166,6 +172,19 @@ aliases {
   volume = [ vol ]
 }
 
+
+// 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
+// requested.
+//
+// These are NOT EASY to set up, so if you want to use these, you'll need to look through the code 
+// for how they work and what fields are needed. Also, it's possible this feature might get entirely
+// removed in the future if I find a better way to do this.
+
+transforms = {}
+
+
 // If you set this to true, it will enable the eval command for the bot owner. This command
 // allows the bot owner to run arbitrary code from the bot's account.
 //
@@ -180,4 +199,4 @@ aliases {
 eval=false
 
 
-/// END OF JMUSICBOT CONFIG ///
+/// END OF JMUSICBOT CONFIG ///