KeyEventServlet.java

package server.restful.servlets.autoplay;

import client.teavm.common.autoplay.KeyEventType;
import com.beust.jcommander.Parameter;
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.HttpFilter;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import libsidplay.components.keyboard.KeyTableEntry;
import server.restful.common.JSIDPlay2Servlet;
import server.restful.common.async.DefaultThreadFactory;
import server.restful.common.async.HttpAsyncContextRunnable;
import server.restful.common.filters.CounterBasedRateLimiterFilter;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.UsageParameter;
import ui.entities.statistics.service.StatisticsService;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.*;

import static client.teavm.common.autoplay.KeyEventType.KEY_TYPED;
import static java.lang.Integer.MIN_VALUE;
import static org.apache.http.HttpStatus.SC_TOO_MANY_REQUESTS;
import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.IServletSystemProperties.KeyEventServlet.*;
import static server.restful.common.ServletUtil.error;
import static server.restful.common.filters.CounterBasedRateLimiterFilter.FILTER_PARAMETER_MAX_REQUESTS_PER_SERVLET;

@WebServlet(name = "KeyEventServlet", displayName = "KeyEventServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET + "/key-event", description = "Key Event trains to automate future key presses")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_ADMIN}))
public class KeyEventServlet extends JSIDPlay2Servlet {

    @Parameters(resourceBundle = "server.restful.servlets.autoplay.KeyEventServletParameters")
    public static class KeyEventServletParameters extends UsageParameter {

        private String sessionID;

        public String getSessionID() {
            return sessionID;
        }

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

        private Boolean jiffyDos = true;

        public Boolean isJiffyDos() {
            return this.jiffyDos;
        }

        @Parameter(names = {"--jiffydos"}, arity = 1, descriptionKey = "JIFFYDOS", order = MIN_VALUE + 2)
        public void setJiffyDos(Boolean jiffyDos) {
            this.jiffyDos = jiffyDos;
        }

        private KeyEventType keyEventType = KEY_TYPED;

        public KeyEventType getKeyEventType() {
            return keyEventType;
        }

        @Parameter(names = {"--keyEventType"}, descriptionKey = "KEY_EVENT_TYPE", required = true, order = MIN_VALUE + 3)
        public void setKeyEventType(KeyEventType keyEventType) {
            this.keyEventType = keyEventType;
        }

        private KeyTableEntry keyTableEntry;

        public KeyTableEntry getKeyTableEntry() {
            return keyTableEntry;
        }

        @Parameter(names = {"--keyTableEntry"}, descriptionKey = "KEY_TABLE_ENTRY", required = true, order = MIN_VALUE + 4)
        public void setKeyTableEntry(KeyTableEntry keyTableEntry) {
            this.keyTableEntry = keyTableEntry;
        }

        private Long eventTime = 0L;

        public Long getEventTime() {
            return eventTime;
        }

        @Parameter(names = {"--eventTime"}, descriptionKey = "EVENT_TIME", order = Integer.MIN_VALUE + 5)
        public void setEventTime(Long eventTime) {
            this.eventTime = eventTime;
        }
    }

    private ExecutorService executorService;

    @Override
    public void init() {
        executorService = new ThreadPoolExecutor(MAX_KEY_EVENT_IN_PARALLEL_CORE, MAX_KEY_EVENT_IN_PARALLEL, KEY_EVENT_KEEPALIVE_TIME, TimeUnit.SECONDS, new ArrayBlockingQueue<>(KEY_EVENT_QUEUE_SIZE), new DefaultThreadFactory("/key-event"), new ThreadPoolExecutor.AbortPolicy());
    }

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

    @Override
    public Map<Class<? extends HttpFilter>, Map<String, String>> getServletFiltersParameterMap() {
        Map<Class<? extends HttpFilter>, Map<String, String>> result = new HashMap<>();

        Map<String, String> counterBasedRateLimiterFilterParameters = new HashMap<>();
        counterBasedRateLimiterFilterParameters.put(FILTER_PARAMETER_MAX_REQUESTS_PER_SERVLET, String.valueOf(MAX_KEY_EVENT));
        result.put(CounterBasedRateLimiterFilter.class, counterBasedRateLimiterFilterParameters);

        return result;
    }

    /**
     * Notify of key-press event.
     * <p>
     * E.g. {@code http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/key-event }
     */
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException {
        AsyncContext asyncContext = request.startAsync(request, response);
        asyncContext.setTimeout(KEY_EVENT_ASYNC_TIMEOUT);

        try {
            executorService.execute(new HttpAsyncContextRunnable(asyncContext, getServletContext()) {
                public void run(HttpServletRequest request, HttpServletResponse response) {
                    try {
                        final KeyEventServletParameters servletParameters = new KeyEventServletParameters();

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

                        if (servletParameters.getHelp() || parser.hasException()) {
                            parser.usage();
                            return;
                        }
                        String sessionId = servletParameters.getSessionID();
                        boolean jiffyDos = servletParameters.isJiffyDos();
                        KeyTableEntry keyTableEntry = servletParameters.getKeyTableEntry();
                        KeyEventType keyEventType = servletParameters.getKeyEventType();
                        Long eventTime = servletParameters.getEventTime();

                        StatisticsService statisticsService = new StatisticsService(getStatisticsEntityManager());
                        statisticsService.insertKeyEvent(sessionId, jiffyDos, keyTableEntry, keyEventType, eventTime);

                    } catch (Throwable t) {
                        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
                        error(getServletContext(), t);
                        setOutput(response, t);
                    } finally {
                        freeStatisticsEntityManager();
                    }
                }
            });
        } catch (RejectedExecutionException e) {
            error(getServletContext(), e);
            response.sendError(SC_TOO_MANY_REQUESTS, "Too Many Requests");
        }
    }
}