Skip to content

Commit

Permalink
Support playlist export to KaraFun Remote V2 (#144)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fcrespel
fcrespel committed Jan 21, 2024
1 parent 6ee6398 commit dffeb8b
Show file tree
Hide file tree
Showing 4 changed files with 387 additions and 144 deletions.
4 changes: 4 additions & 0 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,10 @@
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-websocket</artifactId>
</dependency>

<!-- Springdoc OpenAPI -->
<dependency>
Expand Down
184 changes: 40 additions & 144 deletions src/main/java/me/crespel/karaplan/service/impl/KarafunRemoteExportServiceImpl.java
View file
Original file line number Diff line number Diff line change
@@ -1,171 +1,67 @@
package me.crespel.karaplan.service.impl;

import java.net.URISyntaxException;
import java.util.List;
import java.util.stream.Collectors;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.json.JSONException;
import org.json.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;

import io.socket.client.Ack;
import io.socket.client.IO;
import io.socket.client.Socket;
import io.socket.emitter.Emitter;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import me.crespel.karaplan.config.KarafunConfig.KarafunRemoteProperties;
import me.crespel.karaplan.domain.Playlist;
import me.crespel.karaplan.model.exception.BusinessException;
import me.crespel.karaplan.model.exception.TechnicalException;
import me.crespel.karaplan.service.ExportService;

@Slf4j
@Service("karafunRemoteExport")
public class KarafunRemoteExportServiceImpl implements ExportService {

public static final String EVENT_AUTHENTICATE = "authenticate";
public static final String EVENT_PERMISSIONS = "permissions";
public static final String EVENT_PREFERENCES = "preferences";
public static final String EVENT_STATUS = "status";
public static final String EVENT_QUEUE = "queue";
public static final String EVENT_QUEUE_ADD = "queueAdd";
@Autowired
@Qualifier("karafunRemoteV1Export")
protected ExportService karafunRemoteV1ExportService;

@Autowired
@Qualifier("karafunRemoteV2Export")
protected ExportService karafunRemoteV2ExportService;

@Autowired
private KarafunRemoteProperties properties;

@Autowired
protected KarafunRemoteProperties properties;
private RestTemplate restTemplate;

protected final Pattern remoteTargetPattern = Pattern.compile("[0-9]+");
protected final Pattern remoteDisconnectedPattern = Pattern.compile("reactivate the remote control feature");
protected final Pattern remoteV2UrlPattern = Pattern.compile("\"kcs_url\":\"([^\"]+)\"");

@Override
public void exportPlaylist(Playlist playlist, String target) {
if (!remoteTargetPattern.matcher(target).matches()) {
throw new BusinessException("Invalid KaraFun Remote target, must be numeric");
}
if (playlist.getSongs() != null && !playlist.getSongs().isEmpty()) {
List<Long> songIds = playlist.getSongs().stream().map(it -> it.getSong().getCatalogId()).collect(Collectors.toList());
// Retrieve remote page content
String remotePage;
UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(properties.getEndpoint()).path(target);
try {
Socket socket = buildSocket(target);
socket.on(Socket.EVENT_CONNECT, new ConnectEventListener(socket, target))
.on(Socket.EVENT_CONNECT_ERROR, new LoggingListener(Socket.EVENT_CONNECT_ERROR))
.on(Socket.EVENT_CONNECT_TIMEOUT, new LoggingListener(Socket.EVENT_CONNECT_ERROR))
.on(Socket.EVENT_ERROR, new ErrorEventListener(socket))
.on(Socket.EVENT_MESSAGE, new LoggingListener(Socket.EVENT_CONNECT_ERROR))
.on(Socket.EVENT_DISCONNECT, new LoggingListener(Socket.EVENT_CONNECT_ERROR))
.on(EVENT_PERMISSIONS, new LoggingListener(EVENT_PERMISSIONS))
.on(EVENT_PREFERENCES, new LoggingListener(EVENT_PREFERENCES))
.on(EVENT_STATUS, new LoggingListener(EVENT_STATUS))
.on(EVENT_QUEUE, new QueueEventListener(EVENT_QUEUE, socket, songIds, 0));
log.debug("Connecting to Karafun Remote {}", target);
socket.connect();
} catch (Exception e) {
throw new TechnicalException(e);
remotePage = restTemplate.getForObject(builder.toUriString(), String.class);
if (remoteDisconnectedPattern.matcher(remotePage).find()) {
throw new BusinessException("Remote #" + target + " is not reachable, please check KaraFun application");
}
} catch (RestClientException e) {
throw new TechnicalException("Failed to retrieve KaraFun Remote page, please try again");
}
}
}

protected Socket buildSocket(String remoteId) throws URISyntaxException {
IO.Options opts = new IO.Options();
opts.forceNew = true;
opts.reconnection = false;
opts.query = "remote=kf" + remoteId;
return IO.socket(properties.getEndpoint(), opts);
}

protected JSONObject buildAuthenticateEvent(String remoteId) {
try {
JSONObject obj = new JSONObject();
obj.put("login", "KaraPlan");
obj.put("channel", remoteId);
obj.put("role", "participant");
obj.put("app", "karafun");
obj.put("socket_id", JSONObject.NULL);
return obj;
} catch (JSONException e) {
throw new RuntimeException(e);
}
}

protected JSONObject buildQueueAddEvent(Long songId) {
try {
JSONObject obj = new JSONObject();
obj.put("songId", songId);
obj.put("pos", 99999);
obj.put("singer", "");
return obj;
} catch (JSONException e) {
throw new RuntimeException(e);
}
}

protected void logSendEvent(String eventName, Object... args) {
log.debug("Sending event {}: {}", eventName, args);
}

protected void logReceivedEvent(String eventName, Object... args) {
log.debug("Received event {}: {}", eventName, args);
}

protected void logReceivedAck(String eventName, Object... args) {
log.debug("Received ack for {}: {}", eventName, args);
}

@AllArgsConstructor
public class LoggingListener implements Emitter.Listener {
private final String eventName;

@Override
public void call(Object... args) {
logReceivedEvent(eventName, args);
}
}

@AllArgsConstructor
public class LoggingAck implements Ack {
private final String eventName;

@Override
public void call(Object... args) {
logReceivedAck(eventName, args);
}
}

@AllArgsConstructor
public class ConnectEventListener implements Emitter.Listener {
private final Socket socket;
private final String remoteId;

@Override
public void call(Object... args) {
logReceivedEvent(Socket.EVENT_CONNECT, args);
JSONObject eventData = buildAuthenticateEvent(remoteId);
logSendEvent(EVENT_AUTHENTICATE, eventData);
socket.emit(EVENT_AUTHENTICATE, eventData, new LoggingAck(EVENT_AUTHENTICATE));
}
}

@AllArgsConstructor
public class ErrorEventListener implements Emitter.Listener {
private final Socket socket;

@Override
public void call(Object... args) {
logReceivedEvent(Socket.EVENT_ERROR, args);
socket.disconnect();
}
}

@AllArgsConstructor
public class QueueEventListener implements Emitter.Listener {
private final String eventName;
private final Socket socket;
private final List<Long> songIds;
private int index = 0;

@Override
public void call(Object... args) {
logReceivedEvent(eventName, args);
if (index < songIds.size()) {
JSONObject eventData = buildQueueAddEvent(songIds.get(index++));
logSendEvent(EVENT_QUEUE_ADD, eventData);
socket.emit(EVENT_QUEUE_ADD, eventData);
// Determine remote version
Matcher remoteV2UrlMatcher = remoteV2UrlPattern.matcher(remotePage);
if (remoteV2UrlMatcher.find()) {
String remoteV2Url = remoteV2UrlMatcher.group(1).replace("\\/", "/");
karafunRemoteV2ExportService.exportPlaylist(playlist, remoteV2Url);
} else {
log.debug("Disconnecting from Karafun session");
socket.disconnect();
karafunRemoteV1ExportService.exportPlaylist(playlist, target);
}
}
}
Expand Down
Loading

0 comments on commit dffeb8b

Please sign in to comment.