TuneInfoServlet.java
package server.restful.servlets;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import jakarta.servlet.AsyncContext;
import jakarta.servlet.annotation.HttpConstraint;
import jakarta.servlet.annotation.ServletSecurity;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import javafx.util.Pair;
import libsidplay.sidtune.SidTune;
import server.restful.common.JSIDPlay2Servlet;
import server.restful.common.async.DefaultThreadFactory;
import server.restful.common.async.HttpAsyncContextRunnable;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.requestpath.FileRequestPathServletParameters;
import ui.common.util.SidTuneInfoDetails;
import ui.entities.collection.HVSCEntry;
import ui.musiccollection.SearchCriteria;
import java.io.File;
import java.util.*;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import static java.lang.Integer.MIN_VALUE;
import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.ContentTypeAndFileExtensions.MIME_TYPE_JSON;
import static server.restful.common.IServletSystemProperties.TuneInfoServlet.MAX_TUNE_INFO_IN_PARALLEL;
import static server.restful.common.IServletSystemProperties.TuneInfoServlet.TUNE_INFO_ASYNC_TIMEOUT;
import static server.restful.common.ServletUtil.error;
@WebServlet(name = "TuneInfoServlet", displayName = "TuneInfoServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET
+ "/info/*", description = "Get SID tune infos")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
public class TuneInfoServlet extends JSIDPlay2Servlet {
@SuppressWarnings({"FieldMayBeFinal", "CanBeFinal"})
@Parameters(resourceBundle = "server.restful.servlets.TuneInfoServletParameters")
public static class TuneInfoServletParameters extends FileRequestPathServletParameters {
@Parameter(names = "--list", arity = 1, descriptionKey = "LIST", order = MIN_VALUE + 4)
private Boolean list = Boolean.FALSE;
public Boolean getList() {
return list;
}
}
private ExecutorService executorService;
@Override
public void init() {
executorService = Executors.newFixedThreadPool(MAX_TUNE_INFO_IN_PARALLEL,
new DefaultThreadFactory("/tuneinfo"));
}
@Override
public void destroy() {
executorService.shutdown();
}
/**
* Get SID tune infos.
* <p>
* E.g.
* {@code http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/info/C64Music/MUSICIANS/D/DRAX/Acid.sid }
*/
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) {
AsyncContext asyncContext = request.startAsync(request, response);
asyncContext.setTimeout(TUNE_INFO_ASYNC_TIMEOUT);
executorService.execute(new HttpAsyncContextRunnable(asyncContext, getServletContext()) {
public void run(HttpServletRequest request, HttpServletResponse response) {
try {
final TuneInfoServletParameters servletParameters = new TuneInfoServletParameters();
ServletParameterParser parser = new ServletParameterParser(request, response, servletParameters);
final File file = servletParameters.fetchFile(configuration, directoryProperties, parser,
hasAdminAccess(request));
if (file == null || servletParameters.getHelp() || parser.hasException()) {
parser.usage();
return;
}
Boolean list = servletParameters.getList();
Object tuneInfos = getTuneInfos(file, list);
if (!isComplete()) {
setOutput(MIME_TYPE_JSON, response, tuneInfos);
}
} catch (Throwable t) {
error(getServletContext(), t, parentThread);
if (!isComplete()) {
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
setOutput(response, t);
}
}
}
});
}
private Object getTuneInfos(final File file, final boolean asList) throws Exception {
SidTune tune = SidTune.load(file);
HVSCEntry hvscEntry = createHVSCEntry(file, tune);
ResourceBundle detailsBundle = ResourceBundle.getBundle(SidTuneInfoDetails.BUNDLE, Locale.ENGLISH);
SidTuneInfoDetails details = SidTuneInfoDetails.forFile(tune, file,
configuration.getSidplay2Section().isEnableDatabase() && sidDatabase != null
? sidDatabase::getSongLength : null,
configuration.getSidplay2Section().getDefaultPlayLength(), detailsBundle::getString);
TreeMap<String, String> values = hvscEntry2SortedMap(hvscEntry, details);
return asList ? hvscEntry2SortedList(values) : values;
}
private HVSCEntry createHVSCEntry(File tuneFile, SidTune tune) throws Exception {
return new HVSCEntry(() -> sidDatabase != null ? sidDatabase.getTuneLength(tune) : 0, tuneFile.getName(),
getCollectionName(tuneFile), tuneFile.length(), tuneFile.lastModified(), tune,
String.join(",", tune.identify()));
}
private List<Map<String, String>> hvscEntry2SortedList(Map<String, String> values) {
return values.entrySet().stream().map(entry -> {
Map<String, String> map = new HashMap<>();
map.put("Name", entry.getKey());
map.put("Value", entry.getValue());
return map;
}).collect(Collectors.toList());
}
private TreeMap<String, String> hvscEntry2SortedMap(HVSCEntry hvscEntry, SidTuneInfoDetails details) {
List<Pair<String, String>> attributeValues = SearchCriteria.getAttributeValues(hvscEntry,
field -> field.getAttribute().getDeclaringType().getJavaType().getSimpleName() + "."
+ field.getAttribute().getName());
// Preserve the existing REST property names used by clients for chip-model overrides.
details.getValues().forEach((name, value) -> attributeValues.add(new Pair<>(name, value)));
// same order of keys as in the list
return attributeValues.stream().collect(Collectors.toMap(Pair::getKey, Pair::getValue, (o1, o2) -> {
throw new RuntimeException(String.format("Duplicate key for values %s and %s, I will not merge!", o1, o2));
}, () -> new TreeMap<>((o1, o2) -> index(attributeValues, o1) - index(attributeValues, o2))));
}
private int index(List<Pair<String, String>> attributeValues, String o) {
return IntStream.range(0, attributeValues.size())
.filter(index -> Objects.equals(attributeValues.get(index).getKey(), o)).findFirst().getAsInt();
}
}