USBSIDMappingServlet.java

package server.restful.servlets.sidmapping;

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.jusbsid.JUSBSIDMapping.mapping;
import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.ContentTypeAndFileExtensions.MIME_TYPE_JSON;
import static server.restful.common.IServletSystemProperties.USBSIDMappingServlet.MAX_USBSIDMAPPING_IN_PARALLEL;
import static server.restful.common.IServletSystemProperties.USBSIDMappingServlet.USBSIDMAPPING_ASYNC_TIMEOUT;
import static server.restful.common.ServletUtil.error;

@WebServlet(name = "USBSIDMappingServlet", displayName = "USBSIDMappingServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET
        + "/usbsid-mapping/*", description = "Get USBSID-Pico SID mapping information")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
public class USBSIDMappingServlet extends JSIDPlay2Servlet {

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

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

    }

    private ExecutorService executorService;

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

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

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

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

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

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

                    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;

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

                    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);
                    }
                }
            }
        });
    }

}