HardSIDMappingServlet.java

package server.restful.servlets.sidmapping;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.beust.jcommander.ParametersDelegate;
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 libsidplay.config.IEmulationSection;
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 sidplay.ini.IniConfig;

import java.io.File;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import static builder.jhardsid.JHardSIDMapping.mapping;
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.HardSIDMappingServlet.HARDSIDMAPPING_ASYNC_TIMEOUT;
import static server.restful.common.IServletSystemProperties.HardSIDMappingServlet.MAX_HARDSIDMAPPING_IN_PARALLEL;
import static server.restful.common.ServletUtil.error;

@WebServlet(name = "HardSIDMappingServlet", displayName = "HardSIDMappingServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET
        + "/hardsid-mapping/*", description = "Get HardSID 4U, HardSID UPlay and HardSID Uno SID mapping information")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
public class HardSIDMappingServlet extends JSIDPlay2Servlet {

    @SuppressWarnings("unused")
    @Parameters(resourceBundle = "server.restful.servlets.sidmapping.HardSIDMappingServletParameters")
    public static class HardSIDMappingServletParameters extends FileRequestPathServletParameters {

        private Integer chipCount = 1;

        public Integer getChipCount() {
            return chipCount;
        }

        @Parameter(names = {"--chipCount"}, descriptionKey = "CHIP_COUNT", required = true, order = MIN_VALUE + 4)
        public void setChipCount(Integer chipCount) {
            this.chipCount = chipCount;
        }

        @ParametersDelegate
        private final IEmulationSection emulationSection = new IniConfig().getEmulationSection();

    }

    private ExecutorService executorService;

    @Override
    public void init() {
        executorService = Executors.newFixedThreadPool(MAX_HARDSIDMAPPING_IN_PARALLEL,
                new DefaultThreadFactory("/hardsidmapping"));
    }

    @Override
    public void destroy() {
        executorService.shutdown();
    }

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {

        AsyncContext asyncContext = request.startAsync(request, response);
        asyncContext.setTimeout(HARDSIDMAPPING_ASYNC_TIMEOUT);

        executorService.execute(new HttpAsyncContextRunnable(asyncContext, getServletContext()) {

            public void run(HttpServletRequest request, HttpServletResponse response) {
                try {
                    final HardSIDMappingServletParameters servletParameters = new HardSIDMappingServletParameters();

                    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;
                    }
                    IEmulationSection emulationSection = servletParameters.emulationSection;
                    Integer chipCount = servletParameters.getChipCount();

                    SidTune tune = SidTune.load(file);
                    Map<Integer, String> result = mapping(emulationSection, tune, chipCount);

                    if (!isComplete()) {
                        setOutput(MIME_TYPE_JSON, response, result);
                    }
                } catch (Throwable t) {
                    error(getServletContext(), t, parentThread);
                    if (!isComplete()) {
                        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
                        setOutput(response, t);
                    }
                }
            }
        });
    }

}