Merge pull request #131 from jwdeveloper/develop-1.10.6

Add session id to websocket connection to get authenticated WS as well as optional customizable type for disconnecting websocket client in various ways.

.github/workflows/maven-publish.yml

@@ -46,7 +46,7 @@ jobs:
       run: mkdir staging && cp Client/target/Client-${{steps.version.outputs.version_tag}}-all.jar staging
       
     - name: 5 set up a cache for maven
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
          path: ~/.m2
          key: ${{runner.os}}-m2-${{hashFiles('**/pom.xml')}}

API/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.9.2-Release</version>
+        <version>1.10.5-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>API</artifactId>

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLinkMicArmiesEvent.java

@@ -51,7 +51,6 @@ public class TikTokLinkMicArmiesEvent extends TikTokHeaderEvent {
 
     public TikTokLinkMicArmiesEvent(WebcastLinkMicArmies msg) {
         super(msg.getCommon());
-        System.out.println(msg);
         battleId = msg.getBattleId();
         armies = new HashMap<>();
         picture = Picture.map(msg.getGifIconImage());

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLinkMicBattleEvent.java

@@ -51,7 +51,6 @@ public class TikTokLinkMicBattleEvent extends TikTokHeaderEvent
 
     public TikTokLinkMicBattleEvent(WebcastLinkMicBattle msg) {
         super(msg.getCommon());
-        System.out.println(msg);
         battleId = msg.getBattleId();
         finished = msg.getAction() == BattleAction.BATTLE_ACTION_FINISH;
         battleType = msg.getBattleSetting().getBattleType();
@@ -128,4 +127,37 @@ public class TikTokLinkMicBattleEvent extends TikTokHeaderEvent
         int referencePoints = teams.get(0).getTotalPoints();
         return teams.stream().allMatch(team -> team.getTotalPoints() == referencePoints);
     }
+
+    /**
+     * @param battleHostName name of host to search
+     * @return Team instance containing name of host or null if no team found */
+    public Team getTeam(String battleHostName) {
+        List<Team> list = getTeams(battleHostName);
+        return list.isEmpty() ? null : list.get(0);
+    }
+
+    /**
+     * @param battleHostName name of host to search
+     * @return Team instances not containing name of host */
+    public List<Team> getOpponentTeams(String battleHostName) {
+        List<Team> list = getTeams(battleHostName);
+        return list.isEmpty() ? null : list;
+    }
+
+    /**
+     * @param battleHostName name of host to search
+     * @return {@link List<Team>} with host team first, then opponent teams
+     * <p> If host is in neither or teams is empty, returns empty
+     * <p> Otherwise always teams.length in length;
+     */
+    public List<Team> getTeams(String battleHostName) {
+        if (teams.isEmpty() || teams.stream().noneMatch(team -> team.contains(battleHostName)))
+            return Collections.EMPTY_LIST;
+        Team hostTeam = teams.stream().filter(team -> team.contains(battleHostName)).findFirst().orElseThrow();
+        List<Team> opponentTeams = teams.stream().filter(team -> !team.contains(battleHostName)).toList();
+        List<Team> teams = new ArrayList<>();
+        teams.add(hostTeam);
+        teams.addAll(opponentTeams);
+        return teams;
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/models/battles/Team.java

@@ -81,4 +81,8 @@ public class Team {
         this(anchorInfo);
         this.winStreak = (int) battleCombo.getComboCount();
     }
+
+    public boolean contains(String name) {
+        return hosts.stream().anyMatch(user -> user.getName().equals(name));
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/settings/LiveClientSettings.java

@@ -90,11 +90,18 @@ public class LiveClientSettings {
     private boolean throwOnAgeRestriction;
 
     /**
-	 * Optional: Sometimes not every messages from chat are send to TikTokLiveJava to fix this issue you can set sessionId
-	 * @see <a href="https://github.com/isaackogan/TikTok-Live-Connector#send-chat-messages">Documentation: How to obtain sessionId</a>
+	 * Optional: Sometimes not every messages from chat are send to TikTokLiveJava to fix this issue you can set sessionId.
+     * <p>This requires {@link #ttTargetIdc} also being set correctly for sessionid to be effective.
+	 * @apiNote This cookie is supplied by <a href="https://www.tiktok.com">TikTok</a> and can be found in your browser cookies.
 	 */
     private String sessionId;
 
+    /**
+     * Used with {@link #sessionId} to verify it is valid and return extra chat messages and 18+ content.
+     * @apiNote This cookie is supplied by <a href="https://www.tiktok.com">TikTok</a> and can be found in your browser cookies.
+     */
+    private String ttTargetIdc;
+
     /**
      * Optional: By default roomID is fetched before connect to live, but you can set it manually
      */

API/src/main/java/io/github/jwdeveloper/tiktok/live/LiveClient.java

@@ -51,9 +51,17 @@ public interface LiveClient {
 
     /**
      * Disconnects the connection.
+     * @param type
+     * <p>0 - Normal - Initiates disconnection and returns
+     * <p>1 - Disconnects blocking and returns after closure
+     * <p>2 - Disconnects and kills connection to websocket
+     * <p>Default {@link #disconnect()} is 0
      */
-    void disconnect();
+    void disconnect(int type);
 
+    default void disconnect() {
+        disconnect(0);
+    }
 
     /**
      * Use to manually invoke event

API/src/main/java/io/github/jwdeveloper/tiktok/websocket/LiveSocketClient.java

@@ -27,5 +27,6 @@ import io.github.jwdeveloper.tiktok.live.LiveClient;
 
 public interface LiveSocketClient {
     void start(LiveConnectionData.Response webcastResponse, LiveClient tikTokLiveClient);
-    void stop();
-}
+    void stop(int type);
+    boolean isConnected();
+}

Client/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.9.2-Release</version>
+        <version>1.10.5-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

Client/src/main/java/io/github/jwdeveloper/tiktok/TikTokLiveClient.java

@@ -153,13 +153,12 @@ public class TikTokLiveClient implements LiveClient
         tikTokEventHandler.publish(this, new TikTokRoomInfoEvent(roomInfo));
     }
 
-    public void disconnect() {
-        if (roomInfo.hasConnectionState(ConnectionState.DISCONNECTED)) {
-            return;
-        }
-        setState(ConnectionState.DISCONNECTED);
-        webSocketClient.stop();
-    }
+    public void disconnect(int type) {
+        if (webSocketClient.isConnected())
+            webSocketClient.stop(type);
+		if (!roomInfo.hasConnectionState(ConnectionState.DISCONNECTED))
+			setState(ConnectionState.DISCONNECTED);
+	}
 
     private void setState(ConnectionState connectionState) {
         logger.info("TikTokLive client state: " + connectionState.name());
@@ -174,9 +173,9 @@ public class TikTokLiveClient implements LiveClient
     public void publishMessage(String webcastMessageName, String payloadBase64) {
         this.publishMessage(webcastMessageName, Base64.getDecoder().decode(payloadBase64));
     }
+
     @Override
     public void publishMessage(String webcastMessageName, byte[] payload) {
-
         var builder = ProtoMessageFetchResult.BaseProtoMessage.newBuilder();
         builder.setMethod(webcastMessageName);
         builder.setPayload(ByteString.copyFrom(payload));
@@ -184,7 +183,6 @@ public class TikTokLiveClient implements LiveClient
         messageHandler.handleSingleMessage(this, message);
     }
 
-
     public void connectAsync(Consumer<LiveClient> onConnection) {
         connectAsync().thenAccept(onConnection);
     }

Client/src/main/java/io/github/jwdeveloper/tiktok/TikTokLiveHttpClient.java

@@ -113,6 +113,7 @@ public class TikTokLiveHttpClient implements LiveHttpClient
             .withParam("uniqueId", request.getUserName())
             .withParam("sourceType", "54") //MAGIC NUMBER, WHAT 54 means?
             .withCookie("sessionid", clientSettings.getSessionId())
+            .withCookie("tt-target-idc", clientSettings.getTtTargetIdc())
             .build()
             .toJsonResponse();
 
@@ -141,6 +142,7 @@ public class TikTokLiveHttpClient implements LiveHttpClient
         var result = httpFactory.client(url)
             .withParam("room_id", request.getRoomId())
             .withCookie("sessionid", clientSettings.getSessionId())
+            .withCookie("tt-target-idc", clientSettings.getTtTargetIdc())
             .build()
             .toJsonResponse();
 
@@ -197,6 +199,8 @@ public class TikTokLiveHttpClient implements LiveHttpClient
             .withParam("client", "ttlive-java")
             .withParam("room_id", room_id);
 
+        if (clientSettings.getSessionId() != null) // Allows receiving of all comments and Subscribe Events
+            builder.withParam("session_id", clientSettings.getSessionId());
         if (clientSettings.getApiKey() != null)
             builder.withParam("apiKey", clientSettings.getApiKey());
 

Client/src/main/java/io/github/jwdeveloper/tiktok/websocket/TikTokWebSocketClient.java

@@ -26,10 +26,9 @@ import io.github.jwdeveloper.tiktok.data.dto.ProxyData;
 import io.github.jwdeveloper.tiktok.data.requests.LiveConnectionData;
 import io.github.jwdeveloper.tiktok.data.settings.*;
 import io.github.jwdeveloper.tiktok.exceptions.*;
-import io.github.jwdeveloper.tiktok.live.LiveClient;
-import io.github.jwdeveloper.tiktok.live.LiveEventsHandler;
-import io.github.jwdeveloper.tiktok.live.LiveMessagesHandler;
+import io.github.jwdeveloper.tiktok.live.*;
 import org.java_websocket.client.WebSocketClient;
+import org.java_websocket.framing.CloseFrame;
 
 import javax.net.ssl.*;
 import java.net.Proxy;
@@ -42,7 +41,6 @@ public class TikTokWebSocketClient implements LiveSocketClient {
     private final LiveEventsHandler tikTokEventHandler;
     private final WebSocketHeartbeatTask heartbeatTask;
     private WebSocketClient webSocketClient;
-    private boolean isConnected;
 
     public TikTokWebSocketClient(
             LiveClientSettings clientSettings,
@@ -54,25 +52,23 @@ public class TikTokWebSocketClient implements LiveSocketClient {
         this.messageHandler = messageHandler;
         this.tikTokEventHandler = tikTokEventHandler;
         this.heartbeatTask = heartbeatTask;
-        isConnected = false;
     }
 
     @Override
     public void start(LiveConnectionData.Response connectionData, LiveClient liveClient) {
-        if (isConnected) {
-            stop();
-        }
+        if (isConnected())
+			stop(0);
 
         messageHandler.handle(liveClient, connectionData.getWebcastResponse());
 
         var headers = new HashMap<>(clientSettings.getHttpSettings().getHeaders());
         headers.put("Cookie", connectionData.getWebsocketCookies());
         webSocketClient = new TikTokWebSocketListener(connectionData.getWebsocketUrl(),
-                headers,
-                clientSettings.getHttpSettings().getTimeout().toMillisPart(),
-                messageHandler,
-                tikTokEventHandler,
-                liveClient);
+            headers,
+            clientSettings.getHttpSettings().getTimeout().toMillisPart(),
+            messageHandler,
+            tikTokEventHandler,
+            liveClient);
 
         ProxyClientSettings proxyClientSettings = clientSettings.getHttpSettings().getProxyClientSettings();
         if (proxyClientSettings.isEnabled() && proxyClientSettings.isAllowWebsocket())
@@ -85,9 +81,7 @@ public class TikTokWebSocketClient implements LiveSocketClient {
         try {
             webSocketClient.connect();
             heartbeatTask.run(webSocketClient, clientSettings.getPingInterval());
-            isConnected = true;
         } catch (Exception e) {
-            isConnected = false;
             throw new TikTokLiveException("Failed to connect to the websocket", e);
         }
     }
@@ -117,14 +111,12 @@ public class TikTokWebSocketClient implements LiveSocketClient {
             ProxyData proxyData = proxySettings.next();
 			if (tryProxyConnection(proxySettings, proxyData)) {
 				heartbeatTask.run(webSocketClient, clientSettings.getPingInterval());
-				isConnected = true;
-				break;
+				return;
 			}
             if (proxySettings.isAutoDiscard())
                 proxySettings.remove();
 		}
-        if (!isConnected)
-            throw new TikTokLiveException("Failed to connect to the websocket");
+        throw new TikTokLiveException("Failed to connect to the websocket");
     }
 
     public boolean tryProxyConnection(ProxyClientSettings proxySettings, ProxyData proxyData) {
@@ -137,12 +129,25 @@ public class TikTokWebSocketClient implements LiveSocketClient {
         }
     }
 
-    public void stop() {
-        if (isConnected && webSocketClient != null && webSocketClient.isOpen()) {
-            webSocketClient.closeConnection(0, "");
+    public void stop(int type) {
+        if (isConnected()) {
+            switch (type) {
+				case 1 -> {
+					try {
+						webSocketClient.closeBlocking();
+					} catch (InterruptedException e) {
+                        throw new TikTokLiveException("Failed to stop the websocket");
+                    }
+				}
+                case 2 -> webSocketClient.closeConnection(CloseFrame.NORMAL, "");
+                default -> webSocketClient.close();
+            }
             heartbeatTask.stop();
         }
         webSocketClient = null;
-        isConnected = false;
+    }
+
+    public boolean isConnected() {
+        return webSocketClient != null && webSocketClient.isOpen();
     }
 }

Client/src/main/java/io/github/jwdeveloper/tiktok/websocket/TikTokWebSocketOfflineClient.java

@@ -44,10 +44,13 @@ public class TikTokWebSocketOfflineClient implements LiveSocketClient {
     }
 
     @Override
-    public void stop() {
-        if (liveClient == null) {
-            return;
-        }
-        handler.publish(liveClient, new TikTokDisconnectedEvent("Stopping"));
+    public void stop(int type) {
+		if (liveClient != null)
+			handler.publish(liveClient, new TikTokDisconnectedEvent("Stopping"));
+	}
+
+    @Override
+    public boolean isConnected() {
+        return false;
     }
 }

Client/src/test/java/io/github/jwdeveloper/tiktok/handlers/events/TikTokGiftEventHandlerTest.java

@@ -30,7 +30,6 @@ import io.github.jwdeveloper.tiktok.data.models.gifts.Gift;
 import io.github.jwdeveloper.tiktok.data.models.gifts.GiftComboStateType;
 import io.github.jwdeveloper.tiktok.gifts.TikTokGiftsManager;
 import io.github.jwdeveloper.tiktok.mappers.handlers.TikTokGiftEventHandler;
-import io.github.jwdeveloper.tiktok.messages.data.GiftStruct;
 import io.github.jwdeveloper.tiktok.messages.data.Image;
 import io.github.jwdeveloper.tiktok.messages.data.User;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastGiftMessage;
@@ -111,7 +110,7 @@ class TikTokGiftEventHandlerTest {
                                              int userId,
                                              boolean streakable) {
         var builder = WebcastGiftMessage.newBuilder();
-        var giftBuilder = GiftStruct.newBuilder();
+        var giftBuilder = io.github.jwdeveloper.tiktok.messages.data.Gift.newBuilder();
         var userBuilder = User.newBuilder();
 
 
@@ -129,4 +128,4 @@ class TikTokGiftEventHandlerTest {
     }
 
 
-}
+}

README.md

@@ -70,7 +70,7 @@ Maven
          <dependency>
             <groupId>com.github.jwdeveloper.TikTok-Live-Java</groupId>
             <artifactId>Client</artifactId>
-             <version>1.9.2-Release</version>
+             <version>1.10.0-Release</version>
             <scope>compile</scope>
         </dependency>
    </dependencies>
@@ -87,7 +87,7 @@ dependencyResolutionManagement {
 	}
 
 dependencies {
-	        implementation 'com.github.jwdeveloper.TikTok-Live-Java:Client:1.9.2-Release'
+	        implementation 'com.github.jwdeveloper.TikTok-Live-Java:Client:1.10.0-Release'
 	}
 ```
 

examples/pom.xml

@@ -41,7 +41,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.9.2-Release</version>
+        <version>1.10.5-Release</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>

extension-collector/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
         <artifactId>TikTokLiveJava</artifactId>
-        <version>1.9.2-Release</version>
+        <version>1.10.5-Release</version>
     </parent>
 
 

extension-recorder/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.9.2-Release</version>
+        <version>1.10.5-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>extension-recorder</artifactId>

pom.xml

@@ -7,7 +7,7 @@
     <groupId>io.github.jwdeveloper.tiktok</groupId>
     <artifactId>TikTokLiveJava</artifactId>
     <packaging>pom</packaging>
-    <version>1.9.2-Release</version>
+    <version>1.10.5-Release</version>
     <modules>
         <module>API</module>
         <module>Client</module>

tools-readme/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.9.2-Release</version>
+        <version>1.10.5-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>