StaticServlet.java
package server.restful.servlets;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.beust.jcommander.ParametersDelegate;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import libsidutils.IOUtils;
import org.apache.http.HttpHeaders;
import server.restful.common.ContentTypeAndFileExtensions;
import server.restful.common.JSIDPlay2Servlet;
import server.restful.common.TeaVMFormat;
import server.restful.common.converter.Base64ParameterConverter;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.requestpath.WebResourceRequestPathServletParameters;
import server.restful.common.validator.MaxDirectoriesValidator;
import server.restful.servlets.ConvertServlet.ConvertServletParameters;
import sidplay.ini.IniConfig;
import java.io.InputStream;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.ResourceBundle;
import java.util.ResourceBundle.Control;
import static java.lang.Integer.MIN_VALUE;
import static java.nio.charset.StandardCharsets.UTF_8;
import static libsidutils.IOUtils.convertStreamToString;
import static server.restful.JSIDPlay2Server.CONTEXT_ROOT_STATIC;
import static server.restful.common.ContentTypeAndFileExtensions.getMimeType;
import static server.restful.common.IServletSystemProperties.JSIDPlay2Server.CACHE_CONTROL_RESPONSE_HEADER_CACHED;
import static server.restful.common.IServletSystemProperties.JSIDPlay2Server.CACHE_CONTROL_RESPONSE_HEADER_UNCACHED;
import static server.restful.common.IServletSystemProperties.StaticServlet.SLEEP_TIME;
import static server.restful.common.ServletUtil.createReplacements;
import static server.restful.common.ServletUtil.error;
import static server.restful.common.parameter.ServletParameterHelper.*;
@WebServlet(name = "StaticServlet", displayName = "StaticServlet", urlPatterns = CONTEXT_ROOT_STATIC
+ "/*", description = "Get VUE demo pages or web resources")
public class StaticServlet extends JSIDPlay2Servlet {
/**
* Bump to reset saved browser configuration independently of desktop/INI settings.
*/
private static final int REQUIRED_WEB_CONFIG_VERSION = 5;
@SuppressWarnings({"unused"})
@Parameters(resourceBundle = "server.restful.servlets.StaticServletParameters")
public static class StaticServletParameters extends WebResourceRequestPathServletParameters {
private Boolean useDevTools = Boolean.FALSE;
public Boolean getUseDevTools() {
return useDevTools;
}
@Parameter(names = "--devtools", arity = 1, descriptionKey = "USE_DEV_TOOLS", hidden = true, order = MIN_VALUE
+ 1)
public void setUseDevTools(Boolean useDevTools) {
this.useDevTools = useDevTools;
}
private TeaVMFormat teaVMFormat = TeaVMFormat.WASM_GC_SAB;
public TeaVMFormat getTeaVMFormat() {
return teaVMFormat;
}
@Parameter(names = "--teavmFormat", arity = 1, descriptionKey = "TEAVM_FORMAT", order = MIN_VALUE + 2)
public void setTeaVMFormat(TeaVMFormat teaVMFormat) {
this.teaVMFormat = teaVMFormat;
}
private Integer maxDirectories = 25;
public Integer getMaxDirectories() {
return maxDirectories;
}
@Parameter(names = {
"--maxDirectories"}, descriptionKey = "MAX_DIRECTORIES", validateWith = MaxDirectoriesValidator.class, order = MIN_VALUE
+ 3)
public void setMaxDirectories(Integer maxDirectories) {
this.maxDirectories = maxDirectories;
}
private Integer sleepTime = SLEEP_TIME;
public Integer getSleepTime() {
return sleepTime;
}
@Parameter(names = {"--sleepTime"}, descriptionKey = "SLEEP_TIME", order = MIN_VALUE + 4)
public void setSleepTime(Integer sleepTime) {
this.sleepTime = sleepTime;
}
private String playUrl;
public String getPlayUrl() {
return playUrl;
}
@Parameter(names = {
"--playUrl"}, descriptionKey = "PLAY_URL", converter = Base64ParameterConverter.class, order = MIN_VALUE + 5)
public void setPlayUrl(String playUrl) {
this.playUrl = playUrl;
}
private Boolean sfxSoundExpander = Boolean.FALSE;
public Boolean getSfxSoundExpander() {
return sfxSoundExpander;
}
@Parameter(names = "--sfxSoundExpander", arity = 1, descriptionKey = "SFX_SOUND_EXPANDER", order = MIN_VALUE
+ 6)
public void setSfxSoundExpander(Boolean sfxSoundExpander) {
this.sfxSoundExpander = sfxSoundExpander;
}
private Integer sfxSoundExpanderType = 1;
public Integer getSfxSoundExpanderType() {
return sfxSoundExpanderType;
}
@Parameter(names = {"--sfxSoundExpanderType"}, descriptionKey = "SFX_SOUND_EXPANDER_TYPE", order = MIN_VALUE
+ 7)
public void setSfxSoundExpanderType(Integer sfxSoundExpanderType) {
this.sfxSoundExpanderType = sfxSoundExpanderType;
}
@ParametersDelegate
private final IniConfig config = new IniConfig();
public IniConfig getConfig() {
return config;
}
}
/**
* Get the VUE demo page or web resources.
* <p>
* E.g. {@code http://haendel.ddns.net:8080/static/teavm/c64jukebox.vue }
*/
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) {
try {
final StaticServletParameters servletParameters = new StaticServletParameters();
ServletParameterParser parser = new ServletParameterParser(request, response, servletParameters);
if (servletParameters.getHelp() || parser.hasException()) {
parser.usage();
return;
}
try (InputStream source = servletParameters.getResource()) {
ContentTypeAndFileExtensions mimeType = getMimeType(IOUtils.getFilenameSuffix(request.getPathInfo()));
if (mimeType.isCacheable()) {
response.setHeader(HttpHeaders.CACHE_CONTROL, CACHE_CONTROL_RESPONSE_HEADER_CACHED);
} else {
response.setHeader(HttpHeaders.CACHE_CONTROL, CACHE_CONTROL_RESPONSE_HEADER_UNCACHED);
}
if (servletParameters.getTeaVMFormat() == TeaVMFormat.WASM_GC_SAB && request.getPathInfo() != null
&& request.getPathInfo().contains("teavm")) {
response.setHeader("Cross-Origin-Opener-Policy", "same-origin");
response.setHeader("Cross-Origin-Embedder-Policy", "require-corp");
}
if (mimeType.isText()) {
setOutput(mimeType, response, convertStreamToStringWithDevTools(source, servletParameters));
} else {
setOutput(mimeType, response, source);
}
}
} catch (Throwable t) {
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
error(getServletContext(), t);
setOutput(response, t);
}
}
private String convertStreamToStringWithDevTools(InputStream source, StaticServletParameters servletParameters)
throws JsonProcessingException {
String string = convertStreamToString(source, UTF_8, getReplacements(servletParameters));
if (servletParameters.getUseDevTools()) {
TeaVMFormat teaVMFormat = servletParameters.getTeaVMFormat();
string = string.replace("// $DEVTOOLS_SECTION_1", DEV_TOOLS_SECTION1);
string = string.replace("// $DEVTOOLS_SECTION_2", DEV_TOOLS_SECTION2);
string = string.replace("// $IMPORT_START", teaVMFormat.getImportStmtStart());
string = string.replace("// $IMPORT_END", teaVMFormat.getImportStmtEnd());
string = string.replace("// $DISCRIMINATOR_PATH_MAP", DISCRIMINATOR_PATH.toString());
}
return string;
}
private Map<String, String> getReplacements(StaticServletParameters servletParameters)
throws JsonProcessingException {
final Control control = ResourceBundle.Control.getControl(Control.FORMAT_PROPERTIES);
Map<String, String> replacements = createReplacements(servletParameters.getUseDevTools());
replacements.put("convertOptions", createConvertServletParameters(servletParameters));
replacements.put("defaultConvertOptions", CONVERT_OPTIONS);
replacements.put("requiredWebConfigVersion", String.valueOf(REQUIRED_WEB_CONFIG_VERSION));
replacements.put("defaultFilterNamesReSID6581", FILTER_NAMES_RESID_MOS6581);
replacements.put("defaultFilterNamesReSID8580", FILTER_NAMES_RESID_MOS8580);
replacements.put("defaultFilterNamesReSIDfp6581", FILTER_NAMES_RESIDFP_MOS6581);
replacements.put("defaultFilterNamesReSIDfp8580", FILTER_NAMES_RESIDFP_MOS8580);
replacements.put("defaultFilterNamesReSIDfpCircuit6581", FILTER_NAMES_RESIDFP_CIRCUIT_MOS6581);
replacements.put("defaultFilterNamesReSIDfpCircuit8580", FILTER_NAMES_RESIDFP_CIRCUIT_MOS8580);
for (Locale locale : SUPPORTED_LOCALES) {
String bundleName = control.toBundleName("convertMessages", locale);
replacements.put(bundleName, CONVERT_MESSAGES.get(locale));
}
replacements.put("assembly64Url", configuration.getOnlineSection().getAssembly64Url());
replacements.put("teaVMFormat", servletParameters.getTeaVMFormat().name().toLowerCase(Locale.US));
replacements.put("teaVMFormatName", servletParameters.getTeaVMFormat().getTeaVMFormatName());
replacements.put("teaVMFormatApproximateSize", servletParameters.getTeaVMFormat().getApproximateSize());
replacements.put("teaVMFormatBrowsersExcept", servletParameters.getTeaVMFormat().getBrowsersExcept());
replacements.put("teaVMWorkerAttrs", servletParameters.getTeaVMFormat().getWorkerAttributes());
replacements.put("maxDirectories", String.valueOf(servletParameters.getMaxDirectories()));
replacements.put("sleepTime", String.valueOf(servletParameters.getSleepTime()));
replacements.put("playUrl", Optional.ofNullable(servletParameters.getPlayUrl()).orElse(""));
return replacements;
}
private String createConvertServletParameters(StaticServletParameters servletParameters)
throws JsonProcessingException {
ConvertServletParameters convertServletParameters = new ConvertServletParameters();
convertServletParameters.setConfig(servletParameters.getConfig());
convertServletParameters.setSfxSoundExpander(servletParameters.getSfxSoundExpander());
convertServletParameters.setSfxSoundExpanderType(servletParameters.getSfxSoundExpanderType());
return new ObjectMapper().writeValueAsString(convertServletParameters);
}
}