Merge branch 'dev'

Author: freyacodes

CHANGELOG.md

@@ -3,6 +3,18 @@
 Each release usually includes various fixes and improvements.
 The most noteworthy of these, as well as any features and breaking changes, are listed here.
 
+## v3.2.0.1
+* Bumped to Java 11. Treating this as a patch version, as v3.2 still requires Java 11 due to a Magma update. 
+
+Contributor:
+[@Frederikam](https://github.com/Frederikam/)
+
+## v3.2
+* Added resuming
+
+Contributor:
+[@Frederikam](https://github.com/Frederikam/)
+
 ## v3.1.2
 * Add API version header to all responses
 

IMPLEMENTATION.md

@@ -52,7 +52,7 @@ User-Id: The user id of the bot you are playing music with
 ```
 
 ### Outgoing messages
-Provide an intercepted voice server update. This causes the server to connect to the voice channel
+Provide an intercepted voice server update. This causes the server to connect to the voice channel.
 ```json
 {
     "op": "voiceUpdate",
@@ -65,13 +65,15 @@ Provide an intercepted voice server update. This causes the server to connect to
 Cause the player to play a track.
 `startTime` is an optional setting that determines the number of milliseconds to offset the track by. Defaults to 0.
 `endTime` is an optional setting that determines at the number of milliseconds at which point the track should stop playing. Helpful if you only want to play a snippet of a bigger track. By default the track plays until it's end as per the encoded data.
+`noReplace` if set to true, this operation will be ignored if a track is already playing or paused.
 ```json
 {
     "op": "play",
     "guildId": "...",
     "track": "...",
     "startTime": "60000",
-    "endTime": "120000"
+    "endTime": "120000",
+    "noReplace": false
 }
 ```
 
@@ -139,9 +141,8 @@ and you can send the same VOICE_SERVER_UPDATE to a new node.
 ```
 
 ### Incoming messages
-See 
-[LavalinkSocket.java](https://github.com/FredBoat/Lavalink-Client/blob/master/src/main/java/lavalink/client/io/LavalinkSocket.java)
-for client implementation
+
+See [LavalinkSocket.java](https://github.com/FredBoat/Lavalink-Client/blob/master/src/main/java/lavalink/client/io/LavalinkSocket.java) for client implementation
 
 Position information about a player. Includes unix timestamp.
 ```json
@@ -156,6 +157,7 @@ Position information about a player. Includes unix timestamp.
 ```
 
 A collection of stats sent every minute. 
+
 ```json
 {
     "op": "stats",
@@ -309,10 +311,46 @@ Additionally, in every `/loadtracks` response, a `loadType` property is returned
 
 All REST responses from Lavalink include a `Lavalink-Api-Version` header.
 
+### Resuming Lavalink sessions
+
+What happens after your client disconnects is dependent on whether or not the session has been configured for resuming.
+
+* If resuming is disabled all voice connections are closed immediately.
+* If resuming is enabled all music will continue playing. You will then be able to resume your session, allowing you to control the players again.
+
+To enable resuming, you must send a `configureResuming` message.
+
+* `key` is the string you will need to send when resuming the session. Set to null to disable resuming altogether. Defaults to null.
+* `timeout` is the number of seconds after disconnecting before the session is closed anyways. This is useful for avoiding accidental leaks. Defaults to `60` (seconds).
+
+```json
+{
+    "op": "configureResuming",
+    "key": "myResumeKey",
+    "timeout": 60
+}
+```
+
+To resume a session, specify the resume key in your WebSocket handshake request headers:
+
+```
+Resume-Key: The resume key of the session you want to resume.
+```
+
+You can tell if your session was resumed by looking at the handshake response header `Session-Resumed` which is either `true` or `false`:
+
+```
+Session-Resumed: true
+```
+
+When a session is paused, any events that would normally have been sent is queued up. When the session is resumed, this
+queue is then emptied and the events are then replayed. 
+
 ### Special notes
-* When your shard's mainWS connection dies, so does all your lavalink audio connections.
-    * This also includes resumes
-* When a client connection to Lavalink-Server disconnects, all connections and players for that session are shut down.
+
+* When your shard's main WS connection dies, so does all your lavalink audio connections.
+  * This also includes resumes
+
 * If Lavalink-Server suddenly dies (think SIGKILL) the client will have to terminate any audio connections by sending this event:
 ```json
 {"op":4,"d":{"self_deaf":false,"guild_id":"GUILD_ID_HERE","channel_id":null,"self_mute":false}}

LavalinkServer/build.gradle

@@ -18,8 +18,8 @@ bootJar {
     archiveName = "Lavalink.jar"
 }
 
-sourceCompatibility = 10
-targetCompatibility = 10
+sourceCompatibility = 11
+targetCompatibility = 11
 
 bootRun {
     //compiling tests during bootRun increases the likelihood of catching broken tests locally instead of on the CI

LavalinkServer/docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM openjdk:10-jre-slim
+FROM openjdk:11-jre-slim
 
 WORKDIR /opt/Lavalink
 

LavalinkServer/src/main/java/lavalink/server/config/SentryConfiguration.java

@@ -20,7 +20,6 @@
  */
 
 @Configuration
-@SuppressWarnings("WeakerAccess")
 public class SentryConfiguration {
 
     private static final Logger log = LoggerFactory.getLogger(SentryConfiguration.class);
@@ -59,6 +58,7 @@ public void turnOn(String dsn, Map<String, String> tags) {
         // set the git commit hash this was build on as the release
         Properties gitProps = new Properties();
         try {
+            //noinspection ConstantConditions
             gitProps.load(Launcher.class.getClassLoader().getResourceAsStream("git.properties"));
         } catch (NullPointerException | IOException e) {
             log.error("Failed to load git repo information", e);

LavalinkServer/src/main/java/lavalink/server/io/HandshakeInterceptorImpl.java

@@ -0,0 +1,51 @@
+package lavalink.server.io
+
+import lavalink.server.config.ServerConfig
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.http.server.ServerHttpRequest
+import org.springframework.http.server.ServerHttpResponse
+import org.springframework.stereotype.Controller
+import org.springframework.web.socket.WebSocketHandler
+import org.springframework.web.socket.server.HandshakeInterceptor
+import java.util.Objects
+
+@Controller
+class HandshakeInterceptorImpl @Autowired
+constructor(private val serverConfig: ServerConfig, private val socketServer: SocketServer) : HandshakeInterceptor {
+
+    companion object {
+        private val log = LoggerFactory.getLogger(HandshakeInterceptorImpl::class.java)
+    }
+
+    /**
+     * Checks credentials and sets the Lavalink version header
+     *
+     * @return true if authenticated
+     */
+    override fun beforeHandshake(request: ServerHttpRequest, response: ServerHttpResponse, wsHandler: WebSocketHandler,
+                                 attributes: Map<String, Any>): Boolean {
+        response.headers.add("Lavalink-Major-Version", "3")
+
+        val password = request.headers.getFirst("Authorization")
+        val matches = password == serverConfig.password
+
+        if (matches) {
+            log.info("Incoming connection from " + request.remoteAddress)
+        } else {
+            log.error("Authentication failed from " + request.remoteAddress)
+        }
+
+        val resumeKey = request.headers.getFirst("Resume-Key")
+        val resuming = resumeKey != null && socketServer.canResume(resumeKey)
+        response.headers.add("Session-Resumed", resuming.toString())
+
+        return matches
+    }
+
+    // No action required
+    override fun afterHandshake(request: ServerHttpRequest, response: ServerHttpResponse, wsHandler: WebSocketHandler,
+                                exception: Exception?) {
+    }
+}

LavalinkServer/src/main/java/lavalink/server/io/HandshakeInterceptorImpl.kt

@@ -1,5 +1,6 @@
 package lavalink.server.io;
 
+import org.jetbrains.annotations.NotNull;
 import org.springframework.stereotype.Component;
 import org.springframework.web.filter.OncePerRequestFilter;
 
@@ -13,8 +14,8 @@
 public class ResponseHeaderFilter extends OncePerRequestFilter {
 
     @Override
-    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
-                                    FilterChain filterChain) throws IOException, ServletException {
+    protected void doFilterInternal(@NotNull HttpServletRequest request, @NotNull HttpServletResponse response,
+                                    @NotNull FilterChain filterChain) throws IOException, ServletException {
         response.addHeader("Lavalink-Api-Version", "3");
         filterChain.doFilter(request, response);
     }