Handle Zeroconf correctly by leaving the service always visible (also fixes #42)

devgianlu · devgianlu · commit a60ee4988cba · 2019-01-15T15:37:38.000+01:00
diff --git a/core/src/main/java/xyz/gianlu/librespot/AbsConfiguration.java b/core/src/main/java/xyz/gianlu/librespot/AbsConfiguration.java
@@ -3,14 +3,14 @@
 import org.jetbrains.annotations.Nullable;
 import xyz.gianlu.librespot.core.AuthConfiguration;
 import xyz.gianlu.librespot.core.Session;
-import xyz.gianlu.librespot.core.ZeroconfAuthenticator;
+import xyz.gianlu.librespot.core.ZeroconfServer;
 import xyz.gianlu.librespot.player.CacheManager;
 import xyz.gianlu.librespot.player.Player;
 
 /**
  * @author Gianlu
  */
-public abstract class AbsConfiguration implements Player.Configuration, CacheManager.CacheConfiguration, AuthConfiguration, ZeroconfAuthenticator.Configuration {
+public abstract class AbsConfiguration implements Player.Configuration, CacheManager.CacheConfiguration, AuthConfiguration, ZeroconfServer.Configuration {
 
     @Nullable
     public abstract String deviceName();
diff --git a/core/src/main/java/xyz/gianlu/librespot/DefaultConfiguration.java b/core/src/main/java/xyz/gianlu/librespot/DefaultConfiguration.java
@@ -79,23 +79,23 @@ public Session.DeviceType deviceType() {
     }
 
     @Override
-    public @Nullable String username() {
+    public @Nullable String authUsername() {
         return null;
     }
 
     @Override
-    public @Nullable String password() {
+    public @Nullable String authPassword() {
         return null;
     }
 
     @Override
-    public @Nullable String blob() {
+    public @Nullable String authBlob() {
         return null;
     }
 
     @NotNull
     @Override
-    public Strategy strategy() {
+    public Strategy authStrategy() {
         return Strategy.ZEROCONF;
     }
 
diff --git a/core/src/main/java/xyz/gianlu/librespot/FileConfiguration.java b/core/src/main/java/xyz/gianlu/librespot/FileConfiguration.java
@@ -137,24 +137,24 @@ public boolean logAvailableMixers() {
     }
 
     @Override
-    public @Nullable String username() {
+    public @Nullable String authUsername() {
         return properties.getProperty("auth.username", null);
     }
 
     @Override
-    public @Nullable String password() {
+    public @Nullable String authPassword() {
         return properties.getProperty("auth.password", null);
     }
 
     @Override
-    public @Nullable String blob() {
+    public @Nullable String authBlob() {
         return properties.getProperty("auth.blob", null);
     }
 
     @NotNull
     @Override
-    public Strategy strategy() {
-        return getEnum(Strategy.class, "auth.strategy", defaults.strategy());
+    public Strategy authStrategy() {
+        return getEnum(Strategy.class, "auth.strategy", defaults.authStrategy());
     }
 
     @Override
diff --git a/core/src/main/java/xyz/gianlu/librespot/Main.java b/core/src/main/java/xyz/gianlu/librespot/Main.java
@@ -1,6 +1,8 @@
 package xyz.gianlu.librespot;
 
+import xyz.gianlu.librespot.core.AuthConfiguration;
 import xyz.gianlu.librespot.core.Session;
+import xyz.gianlu.librespot.core.ZeroconfServer;
 import xyz.gianlu.librespot.mercury.MercuryClient;
 import xyz.gianlu.librespot.spirc.SpotifyIrc;
 
@@ -13,11 +15,12 @@
  */
 public class Main {
 
-    public static void main(String[] args) throws IOException, GeneralSecurityException, Session.SpotifyAuthenticationException, SpotifyIrc.IrcException, MercuryClient.PubSubException, InterruptedException {
-        Session session = new Session.Builder(new FileConfiguration(new File("conf.properties"), args)).create();
-
-        Thread.sleep(8000);
-
-        session.close();
+    public static void main(String[] args) throws IOException, GeneralSecurityException, Session.SpotifyAuthenticationException, SpotifyIrc.IrcException, MercuryClient.PubSubException {
+        AbsConfiguration conf = new FileConfiguration(new File("conf.properties"), args);
+        if (conf.authStrategy() == AuthConfiguration.Strategy.ZEROCONF) {
+            ZeroconfServer.create(conf);
+        } else {
+            new Session.Builder(conf).create();
+        }
     }
 }
diff --git a/core/src/main/java/xyz/gianlu/librespot/core/AuthConfiguration.java b/core/src/main/java/xyz/gianlu/librespot/core/AuthConfiguration.java
@@ -8,16 +8,16 @@
  */
 public interface AuthConfiguration {
     @Nullable
-    String username();
+    String authUsername();
 
     @Nullable
-    String password();
+    String authPassword();
 
     @Nullable
-    String blob();
+    String authBlob();
 
     @NotNull
-    Strategy strategy();
+    Strategy authStrategy();
 
     enum Strategy {
         FACEBOOK, BLOB,
diff --git a/core/src/main/java/xyz/gianlu/librespot/core/FacebookAuthenticator.java b/core/src/main/java/xyz/gianlu/librespot/core/FacebookAuthenticator.java
@@ -80,7 +80,7 @@ private void authData(@NotNull String json) {
 
         JsonObject data = obj.getAsJsonObject("credentials");
         credentials = Authentication.LoginCredentials.newBuilder()
-                .setUsername(data.get("username").getAsString())
+                .setUsername(data.get("authUsername").getAsString())
                 .setTyp(Authentication.AuthenticationType.forNumber(data.get("auth_type").getAsInt()))
                 .setAuthData(ByteString.copyFrom(Base64.getDecoder().decode(data.get("encoded_auth_blob").getAsString())))
                 .build();
diff --git a/core/src/main/java/xyz/gianlu/librespot/core/Session.java b/core/src/main/java/xyz/gianlu/librespot/core/Session.java
@@ -75,7 +75,12 @@ private static int readBlobInt(ByteBuffer buffer) {
         return lo & 0x7f | hi << 7;
     }
 
-    private void connect() throws IOException, GeneralSecurityException, SpotifyAuthenticationException {
+    @NotNull
+    static Session from(@NotNull Inner inner) throws IOException {
+        return new Session(inner, ApResolver.getSocketFromRandomAccessPoint());
+    }
+
+    void connect() throws IOException, GeneralSecurityException, SpotifyAuthenticationException {
         Accumulator acc = new Accumulator();
 
         // Send ClientHello
@@ -191,7 +196,7 @@ private void connect() throws IOException, GeneralSecurityException, SpotifyAuth
         LOGGER.info("Connected successfully!");
     }
 
-    private void authenticate(@NotNull Authentication.LoginCredentials credentials) throws IOException, GeneralSecurityException, SpotifyAuthenticationException, MercuryClient.PubSubException, SpotifyIrc.IrcException {
+    void authenticate(@NotNull Authentication.LoginCredentials credentials) throws IOException, GeneralSecurityException, SpotifyAuthenticationException, MercuryClient.PubSubException, SpotifyIrc.IrcException {
         if (cipherPair == null) throw new IllegalStateException("Connection not established!");
 
         Authentication.ClientResponseEncrypted clientResponseEncrypted = Authentication.ClientResponseEncrypted.newBuilder()
@@ -300,6 +305,10 @@ public Authentication.APWelcome apWelcome() {
         return apWelcome;
     }
 
+    public boolean valid() {
+        return apWelcome != null && !socket.isClosed();
+    }
+
     @NotNull
     public String deviceId() {
         return inner.deviceId;
@@ -360,6 +369,19 @@ private Inner(DeviceType deviceType, String deviceName, AbsConfiguration configu
             this.deviceId = UUID.randomUUID().toString();
         }
 
+        @NotNull
+        static Inner from(@NotNull AbsConfiguration configuration) {
+            String deviceName = configuration.deviceName();
+            if (deviceName == null || deviceName.isEmpty())
+                throw new IllegalArgumentException("Device name required: " + deviceName);
+
+            DeviceType deviceType = configuration.deviceType();
+            if (deviceType == null)
+                throw new IllegalArgumentException("Device type required!");
+
+            return new Inner(deviceType, deviceName, configuration);
+        }
+
         @NotNull Authentication.LoginCredentials decryptBlob(String username, byte[] encryptedBlob) throws GeneralSecurityException, IOException {
             encryptedBlob = Base64.getDecoder().decode(encryptedBlob);
 
@@ -408,28 +430,18 @@ public static class Builder {
         private final Inner inner;
         private Authentication.LoginCredentials loginCredentials = null;
         private AuthConfiguration authConf;
-        private ZeroconfAuthenticator.Configuration zeroconfConf;
 
         public Builder(@NotNull DeviceType deviceType, @NotNull String deviceName, @NotNull AbsConfiguration configuration) {
             this.inner = new Inner(deviceType, deviceName, configuration);
             this.authConf = configuration;
-            this.zeroconfConf = configuration;
         }
 
         public Builder(@NotNull AbsConfiguration configuration) {
-            String deviceName = configuration.deviceName();
-            if (deviceName == null || deviceName.isEmpty())
-                throw new IllegalArgumentException("Device name required: " + deviceName);
-
-            DeviceType deviceType = configuration.deviceType();
-            if (deviceType == null)
-                throw new IllegalArgumentException("Device type required!");
-
-            this.inner = new Inner(deviceType, deviceName, configuration);
+            this.inner = Inner.from(configuration);
             this.authConf = configuration;
-            this.zeroconfConf = configuration;
         }
 
+        @NotNull
         public Builder facebook() throws IOException {
             try (FacebookAuthenticator authenticator = new FacebookAuthenticator()) {
                 loginCredentials = authenticator.lockUntilCredentials();
@@ -439,20 +451,13 @@ public Builder facebook() throws IOException {
             }
         }
 
-        public Builder zeroconf() throws IOException {
-            try (ZeroconfAuthenticator authenticator = new ZeroconfAuthenticator(inner, zeroconfConf)) {
-                loginCredentials = authenticator.lockUntilCredentials();
-                return this;
-            } catch (InterruptedException ex) {
-                throw new IOException(ex);
-            }
-        }
-
+        @NotNull
         public Builder blob(String username, byte[] blob) throws GeneralSecurityException, IOException {
             loginCredentials = inner.decryptBlob(username, blob);
             return this;
         }
 
+        @NotNull
         public Builder userPass(@NotNull String username, @NotNull String password) {
             loginCredentials = Authentication.LoginCredentials.newBuilder()
                     .setUsername(username)
@@ -466,36 +471,35 @@ public Builder userPass(@NotNull String username, @NotNull String password) {
         public Session create() throws IOException, GeneralSecurityException, SpotifyAuthenticationException, MercuryClient.PubSubException, SpotifyIrc.IrcException {
             if (loginCredentials == null) {
                 if (authConf != null) {
-                    String blob = authConf.blob();
-                    String username = authConf.username();
-                    String password = authConf.password();
+                    String blob = authConf.authBlob();
+                    String username = authConf.authUsername();
+                    String password = authConf.authPassword();
 
-                    switch (authConf.strategy()) {
+                    switch (authConf.authStrategy()) {
                         case FACEBOOK:
                             facebook();
                             break;
                         case BLOB:
-                            if (username == null) throw new IllegalArgumentException("Missing username!");
-                            if (blob == null) throw new IllegalArgumentException("Missing blob!");
+                            if (username == null) throw new IllegalArgumentException("Missing authUsername!");
+                            if (blob == null) throw new IllegalArgumentException("Missing authBlob!");
                             blob(username, Base64.getDecoder().decode(blob));
                             break;
                         case USER_PASS:
-                            if (username == null) throw new IllegalArgumentException("Missing username!");
-                            if (password == null) throw new IllegalArgumentException("Missing password!");
+                            if (username == null) throw new IllegalArgumentException("Missing authUsername!");
+                            if (password == null) throw new IllegalArgumentException("Missing authPassword!");
                             userPass(username, password);
                             break;
                         case ZEROCONF:
-                            zeroconf();
-                            break;
+                            throw new IllegalStateException("Cannot handle ZEROCONF! Use ZeroconfServer.");
                         default:
-                            throw new IllegalStateException("Unknown auth strategy: " + authConf.strategy());
+                            throw new IllegalStateException("Unknown auth authStrategy: " + authConf.authStrategy());
                     }
                 } else {
                     throw new IllegalStateException("Missing credentials!");
                 }
             }
 
-            Session session = new Session(inner, ApResolver.getSocketFromRandomAccessPoint());
+            Session session = Session.from(inner);
             session.connect();
             session.authenticate(loginCredentials);
             return session;
diff --git a/core/src/main/java/xyz/gianlu/librespot/core/ZeroconfServer.java b/core/src/main/java/xyz/gianlu/librespot/core/ZeroconfServer.java

Original file line number	Diff line number	Diff line change
`@@ -79,23 +79,23 @@ public Session.DeviceType deviceType() {`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`@Override`
`82`		`- public @Nullable String username() {`
	`82`	`+ public @Nullable String authUsername() {`
`83`	`83`	`return null;`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`@Override`
`87`		`- public @Nullable String password() {`
	`87`	`+ public @Nullable String authPassword() {`
`88`	`88`	`return null;`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`@Override`
`92`		`- public @Nullable String blob() {`
	`92`	`+ public @Nullable String authBlob() {`
`93`	`93`	`return null;`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`@NotNull`
`97`	`97`	`@Override`
`98`		`- public Strategy strategy() {`
	`98`	`+ public Strategy authStrategy() {`
`99`	`99`	`return Strategy.ZEROCONF;`
`100`	`100`	`}`
`101`	`101`
Original file line number	Diff line number	Diff line change
`@@ -137,24 +137,24 @@ public boolean logAvailableMixers() {`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`@Override`
`140`		`- public @Nullable String username() {`
	`140`	`+ public @Nullable String authUsername() {`
`141`	`141`	`return properties.getProperty("auth.username", null);`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`@Override`
`145`		`- public @Nullable String password() {`
	`145`	`+ public @Nullable String authPassword() {`
`146`	`146`	`return properties.getProperty("auth.password", null);`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`@Override`
`150`		`- public @Nullable String blob() {`
	`150`	`+ public @Nullable String authBlob() {`
`151`	`151`	`return properties.getProperty("auth.blob", null);`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`@NotNull`
`155`	`155`	`@Override`
`156`		`- public Strategy strategy() {`
`157`		`- return getEnum(Strategy.class, "auth.strategy", defaults.strategy());`
	`156`	`+ public Strategy authStrategy() {`
	`157`	`+ return getEnum(Strategy.class, "auth.strategy", defaults.authStrategy());`
`158`	`158`	`}`
`159`	`159`
`160`	`160`	`@Override`