SongLengthServlet.java

package server.restful.servlets;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import jakarta.servlet.AsyncContext;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import libsidplay.sidtune.SidTune;
import libsidplay.sidtune.SidTuneError;
import libsidutils.IOUtils;
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.UsageParameter;
import ui.entities.config.SidPlay2Section;

import java.io.File;
import java.io.IOException;
import java.util.AbstractMap.SimpleEntry;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import static java.lang.Integer.MIN_VALUE;
import static server.restful.JSIDPlay2Server.CONTEXT_ROOT_SERVLET;
import static server.restful.common.ContentTypeAndFileExtensions.MIME_TYPE_JSON;
import static server.restful.common.IServletSystemProperties.SongLength.MAX_SONG_LENGTH_IN_PARALLEL;
import static server.restful.common.IServletSystemProperties.SongLength.SONG_LENGTH_ASYNC_TIMEOUT;
import static server.restful.common.ServletUtil.error;

@WebServlet(name = "SongLengthServlet", displayName = "SongLengthServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET
        + "/songlength", description = "Get SID tune's current song length")
public class SongLengthServlet extends JSIDPlay2Servlet {

    @SuppressWarnings("unused")
    @Parameters(resourceBundle = "server.restful.servlets.SongLengthServletParameters")
    public static class SongLengthServletParameters extends UsageParameter {

        private String md5;

        public String getMd5() {
            return md5;
        }

        @Parameter(names = {"--md5"}, descriptionKey = "MD5", required = true, order = MIN_VALUE + 1)
        public void setMd5(String md5) {
            this.md5 = md5;
        }

        private Integer songNumber;

        public Integer getSongNumber() {
            return songNumber;
        }

        @Parameter(names = {"--songNumber"}, descriptionKey = "SONG_NUMBER", order = MIN_VALUE + 2)
        public void setSongNumber(Integer songNumber) {
            this.songNumber = songNumber;
        }

    }

    private ExecutorService executorService;

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

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

    /**
     * Get Song length of SID tune identified by MD5.
     * <p>
     * E.g.
     * {@code
     * http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/songlength?md5=07c2089f10a304ffa84131590e6665e5 }
     */
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {

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

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

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

                    ServletParameterParser parser = new ServletParameterParser(request, response, servletParameters);

                    if (servletParameters.getHelp() || parser.hasException()) {
                        parser.usage();
                        return;
                    }
                    String md5 = servletParameters.getMd5();
                    Integer songNumber = servletParameters.getSongNumber();

                    SimpleEntry<String, Double> songLength = getSongLength(md5, songNumber);

                    if (!isComplete()) {
                        response.setHeader("path", songLength.getKey());
                        setOutput(MIME_TYPE_JSON, response, songLength.getValue());
                    }
                } catch (Throwable t) {
                    error(getServletContext(), t);
                    if (!isComplete()) {
                        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
                        setOutput(response, t);
                    }
                }
            }
        });
    }

    private SimpleEntry<String, Double> getSongLength(String md5, Integer songNumber) throws IOException, SidTuneError {
        SidPlay2Section sidplay2Section = configuration.getSidplay2Section();

        if (sidDatabase != null) {
            String path = sidDatabase.getPath(md5);

            if (sidplay2Section.getHvsc() != null && path != null) {
                File file = IOUtils.getFile(path, sidplay2Section.getHvsc(), null);

                if (file.exists()) {
                    SidTune tune = SidTune.load(file);
                    tune.getInfo().setSelectedSong(songNumber);
                    return new SimpleEntry<>(path, sidDatabase.getLength(md5, tune.getInfo().getSelectedSong()));
                }
            }
        }
        return new SimpleEntry<>("", 0.);
    }

}