FavoritesServlet.java
package server.restful.servlets;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.fasterxml.jackson.annotation.JsonProperty;
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 libsidutils.IOUtils;
import server.restful.common.JSIDPlay2Servlet;
import server.restful.common.converter.WebResourceConverter;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.UsageParameter;
import ui.entities.collection.HVSCEntry;
import ui.entities.config.FavoritesSection;
import java.io.InputStream;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
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.ServletUtil.error;
@WebServlet(name = "FavoritesServlet", displayName = "FavoritesServlet", urlPatterns = CONTEXT_ROOT_SERVLET
+ "/favorites", description = "Get contents of a favorites tab")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
public class FavoritesServlet extends JSIDPlay2Servlet {
public static final String BUILT_IN_FAVORITES_PATH = "/favorites/jsidplay2-%d.json";
@SuppressWarnings("unused")
@Parameters(resourceBundle = "server.restful.servlets.FavoritesServletParameters")
public static class FavoritesServletParameters extends UsageParameter {
private Integer favoritesNumber = null;
public Integer getFavoritesNumber() {
return favoritesNumber;
}
@Parameter(names = {"--favoritesNumber"}, descriptionKey = "FAVORITES_NUMBER", order = MIN_VALUE + 1)
public void setFavoritesNumber(Integer favoritesNumber) {
this.favoritesNumber = favoritesNumber;
}
}
@SuppressWarnings("FieldMayBeFinal")
private static class FavoritesWrapper {
private FavoritesWrapper(String filename) {
this.filename = filename;
}
@JsonProperty
private String filename;
}
/**
* Get the contents of the first SID favorites tab.
* <p>
* E.g. {@code http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/favorites }
*/
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) {
try {
final FavoritesServletParameters servletParameters = new FavoritesServletParameters();
ServletParameterParser parser = new ServletParameterParser(request, response, servletParameters);
if (servletParameters.getHelp() || parser.hasException()) {
parser.usage();
return;
}
final Integer favoritesNumber = servletParameters.getFavoritesNumber();
List<FavoritesSection> nonEmptyFavoriteSections = configuration.getFavorites().stream()
.filter(favoritesSection -> !favoritesSection.getFavorites().isEmpty())
.collect(Collectors.toList());
if (favoritesNumber == null) { // jsidplay2app compatibility, only
List<String> favorites = getFavoritesByNumber(nonEmptyFavoriteSections, 0).stream().map(fav -> fav.filename)
.collect(Collectors.toList());
setOutput(MIME_TYPE_JSON, response, favorites);
} else if (favoritesNumber < nonEmptyFavoriteSections.size()) {
List<FavoritesWrapper> favorites = getFavoritesByNumber(nonEmptyFavoriteSections, favoritesNumber);
setOutput(MIME_TYPE_JSON, response, favorites);
} else {
String resource = String.format(BUILT_IN_FAVORITES_PATH,
(favoritesNumber - nonEmptyFavoriteSections.size()));
try (InputStream is = new WebResourceConverter(SERVLET_PATH).convert(resource)) {
setOutput(MIME_TYPE_JSON, response, is);
}
}
} catch (Throwable t) {
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
error(getServletContext(), t);
setOutput(response, t);
}
}
private List<FavoritesWrapper> getFavoritesByNumber(List<FavoritesSection> nonEmptyFavoriteSections, Integer favoritesNumber) {
return nonEmptyFavoriteSections.stream()
.filter(favorites -> nonEmptyFavoriteSections.indexOf(favorites) == favoritesNumber).findFirst()
.map(FavoritesSection::getFavorites).orElseGet(Collections::emptyList).stream().map(this::getFavorite)
.filter(Objects::nonNull)
.collect(Collectors.toList());
}
private FavoritesWrapper getFavorite(HVSCEntry entry) {
if (!IOUtils.getFiles(entry.getPath(), configuration.getSidplay2Section().getHvsc(), null).isEmpty()) {
return new FavoritesWrapper(C64_MUSIC + entry.getPath());
} else if (!IOUtils.getFiles(entry.getPath(), configuration.getSidplay2Section().getCgsc(), null).isEmpty()) {
return new FavoritesWrapper(CGSC + entry.getPath());
}
return null;
}
}