DownloadServlet.java

package server.restful.servlets;

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 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 java.io.File;
import java.net.URLEncoder;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import static java.nio.charset.StandardCharsets.UTF_8;
import static libsidutils.IOUtils.getFilenameSuffix;
import static libsidutils.ZipFileUtils.newFileInputStream;
import static org.apache.tomcat.util.http.fileupload.FileUploadBase.ATTACHMENT;
import static org.apache.tomcat.util.http.fileupload.FileUploadBase.CONTENT_DISPOSITION;
import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.ContentTypeAndFileExtensions.getMimeType;
import static server.restful.common.IServletSystemProperties.DownloadServlet.DOWNLOAD_ASYNC_TIMEOUT;
import static server.restful.common.IServletSystemProperties.DownloadServlet.MAX_DOWNLOAD_IN_PARALLEL;
import static server.restful.common.ServletUtil.error;

@WebServlet(name = "DownloadServlet", displayName = "DownloadServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET
        + "/download/*", description = "Download SID")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
public class DownloadServlet extends JSIDPlay2Servlet {

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

    }

    private ExecutorService executorService;

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

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

    /**
     * Download SID.
     * <p>
     * E.g.
     * {@code
     * http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/download/C64Music/MUSICIANS/D/DRAX/Worktunes/Outro.sid
     * }
     */
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {

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

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

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

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

                    if (!isComplete()) {
                        response.addHeader(CONTENT_DISPOSITION,
                                ATTACHMENT + "; filename=" + URLEncoder.encode(file.getName(), UTF_8));
                        response.setContentLength((int) file.length());
                        setOutput(getMimeType(getFilenameSuffix(file.getName())), response, newFileInputStream(file));
                    }
                } catch (Throwable t) {
                    error(getServletContext(), t, parentThread);
                    if (!isComplete()) {
                        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
                        setOutput(response, t);
                    }
                }
            }
        });
    }

}