kr.motd.maven.sphinx.SphinxRunner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sphinx-maven-plugin Show documentation
Show all versions of sphinx-maven-plugin Show documentation
Maven plugin that creates the site with Sphinx
package kr.motd.maven.sphinx;
import static java.util.Objects.requireNonNull;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOError;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.math.BigInteger;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.nio.file.attribute.PosixFilePermissions;
import java.security.CodeSource;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.concurrent.TimeUnit;
import net.sourceforge.plantuml.UmlDiagram;
import kr.motd.maven.os.DetectionException;
import kr.motd.maven.os.Detector;
/**
* Sphinx Runner.
*/
public class SphinxRunner {
private static final OsDetector osDetector = new OsDetector();
public static final String DEFAULT_BINARY_URL =
"https://github.com/trustin/sphinx-binary/releases/download/v0.5.0/sphinx." +
osDetector.executableSuffix();
private static final String VERSION;
private static final String USER_AGENT;
static {
final Properties versionProps = new Properties();
try {
versionProps.load(SphinxRunner.class.getResourceAsStream("version.properties"));
} catch (IOException e) {
throw new IOError(e);
}
VERSION = versionProps.getProperty("version");
if (VERSION == null) {
throw new IllegalStateException("cannot determine the plugin version");
}
USER_AGENT = SphinxRunner.class.getSimpleName() + '/' + VERSION;
}
private final String binaryUrl;
private final File binaryCacheDir;
private final Map environments;
private final SphinxRunnerLogger logger;
private final String plantUmlCommand;
public SphinxRunner(String binaryUrl, File binaryCacheDir,
Map environments, String dotBinary, SphinxRunnerLogger logger) {
this.binaryUrl = requireNonNull(binaryUrl, "binaryUrl");
if (!binaryUrl.startsWith("http://") &&
!binaryUrl.startsWith("https://") &&
!binaryUrl.startsWith("file:")) {
throw new IllegalArgumentException("binaryUrl must start with 'file:', 'http://' or 'https://': " +
binaryUrl);
}
this.binaryCacheDir = requireNonNull(binaryCacheDir, "binaryCacheDir");
this.logger = requireNonNull(logger, "logger");
this.environments = new HashMap<>(requireNonNull(environments, "environments"));
final StringBuilder plantUmlCommandBuf = new StringBuilder();
plantUmlCommandBuf.append("java ");
plantUmlCommandBuf.append("-Djava.awt.headless=true ");
plantUmlCommandBuf.append("-jar ");
plantUmlCommandBuf.append(findPlantUmlJar().getPath().replace("\\", "\\\\"));
if (dotBinary != null) {
plantUmlCommandBuf.append(" -graphvizdot ");
plantUmlCommandBuf.append(dotBinary.replace("\\", "\\\\"));
}
plantUmlCommand = plantUmlCommandBuf.toString();
}
public final int run(File workingDir, List args) {
requireNonNull(workingDir, "workingDir");
requireNonNull(args, "args");
if (args.isEmpty()) {
throw new IllegalArgumentException("args is empty.");
}
final Path sphinxBinary = downloadSphinxBinary();
final List fullArgs = new ArrayList<>();
fullArgs.add(sphinxBinary.toString());
fullArgs.addAll(args);
final ProcessBuilder builder = new ProcessBuilder(fullArgs);
final Map env = builder.environment();
builder.directory(workingDir);
configureProcessBuilder(builder);
// Set the locale and timezone for consistency.
env.put("LANG", "en_US.UTF-8");
env.put("LC_ALL", "en_US.UTF-8");
env.put("TZ", "UTC");
// Set the command that runs PlantUML.
env.put("plantuml", plantUmlCommand);
env.putAll(environments);
try {
final long startTime = System.nanoTime();
final Process process = builder.start();
process.getOutputStream().close();
redirect(process.getInputStream(), process.getErrorStream());
final int exitCode = process.waitFor();
logger.log("Sphinx exited with code " + exitCode + ". Took " +
TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime) + "ms.");
return exitCode;
} catch (Exception e) {
throw new SphinxException("Failed to run Sphinx: " + e, e);
}
}
protected void configureProcessBuilder(ProcessBuilder builder) {}
private void redirect(final InputStream stdout, final InputStream stderr) {
if (stdout != null) {
new Thread(new Runnable() {
@Override
public void run() {
try {
redirectStdout(stdout);
} catch (Throwable t) {
logger.log("Failed to redirect stdout: " + t);
} finally {
try {
stdout.close();
} catch (IOException e) {
// Swallow.
}
}
}
}, "sphinx-redirect-stdout").start();
}
if (stderr != null) {
new Thread(new Runnable() {
@Override
public void run() {
try {
redirectStderr(stderr);
} catch (Throwable t) {
logger.log("Failed to redirect stderr: " + t);
} finally {
try {
stdout.close();
} catch (IOException e) {
// Swallow.
}
}
}
}, "sphinx-redirect-stderr").start();
}
}
protected void redirectStdout(InputStream stdout) throws Exception {
redirect(stdout, System.out);
}
protected void redirectStderr(InputStream stderr) throws Exception {
redirect(stderr, System.out);
}
protected void redirect(InputStream in, OutputStream out) throws Exception {
final byte[] buf = new byte[8192];
for (;;) {
final int readBytes = in.read(buf);
if (readBytes < 0) {
break;
}
if (readBytes > 0) {
out.write(buf, 0, readBytes);
}
}
}
private static File findPlantUmlJar() {
return findJar(UmlDiagram.class, "PlantUML JAR");
}
private static File findJar(Class type, String name) {
final CodeSource codeSource = type.getProtectionDomain().getCodeSource();
if (codeSource == null) {
throw new SphinxException(
"failed to get the location of " + name + " (CodeSource not available)");
}
final URL url = codeSource.getLocation();
if (!"file".equals(url.getProtocol()) || !url.getPath().toLowerCase(Locale.US).endsWith(".jar")) {
throw new SphinxException(
"failed to get the location of " + name + " (unexpected URL: " + url + ')');
}
File f;
try {
f = new File(url.toURI());
} catch (URISyntaxException ignored) {
f = new File(url.getPath());
}
return f;
}
private Path downloadSphinxBinary() {
if (binaryUrl.startsWith("file:")) {
URL url = null;
File f = null;
try {
url = new URL(binaryUrl);
f = new File(url.toURI());
} catch (Exception ignored) {
if (url != null) {
f = new File(url.getPath());
}
}
if (f == null || !f.exists()) {
throw new SphinxException("failed to locate Sphinx binary: " + binaryUrl);
}
return f.toPath();
}
final File binaryDir = new File(binaryCacheDir, binaryUrl.replaceAll("[/\\\\<>:\"|?*]", "_"));
binaryDir.mkdirs();
if (!binaryDir.isDirectory()) {
throw new SphinxException(
"failed to create a cache directory: " + binaryDir);
}
final String binaryName = "sphinx." + osDetector.executableSuffix();
final String sha256Name = binaryName + ".sha256";
final Path binary = new File(binaryDir, binaryName).toPath();
final Path sha256 = new File(binaryDir, sha256Name).toPath();
if (Files.exists(binary)) {
// Downloaded already.
return binary;
}
final URI binaryUri = URI.create(binaryUrl);
final URI sha256Uri = URI.create(binaryUrl + ".sha256");
Path tmpBinary = null;
Path tmpSha256 = null;
try {
// Download the binary and sha256 checksum.
tmpBinary = newTempExecutableFile(binary.getParent(), binaryName);
download(binaryUri, tmpBinary);
tmpSha256 = newTempRegularFile(binary.getParent(), sha256Name);
download(sha256Uri, tmpSha256);
// Make sure the sha256 checksum is valid.
final List sha256Lines = Files.readAllLines(tmpSha256, StandardCharsets.US_ASCII);
if (sha256Lines.size() != 1 || !sha256Lines.get(0).matches("^[0-9a-fA-F]{64}(?:\\s.*$|$)")) {
throw new SphinxException("invalid content: " + sha256Uri);
}
final Sha256 digest = new Sha256();
final byte[] buffer = new byte[65536];
try (FileInputStream in = new FileInputStream(tmpBinary.toFile())) {
for (;;) {
final int readBytes = in.read(buffer);
if (readBytes < 0) {
break;
}
if (readBytes != 0) {
digest.update(buffer, 0, readBytes);
}
}
}
final byte[] actualSha256Sum = new byte[digest.getDigestLen()];
digest.finishDigest(actualSha256Sum, 0);
if (!new BigInteger(sha256Lines.get(0), 16).equals(new BigInteger(1, actualSha256Sum))) {
throw new SphinxException("mismatching checksum: " + binaryUri);
}
// Move the downloaded and verified files to the desired locations.
Files.move(tmpSha256, sha256,
StandardCopyOption.ATOMIC_MOVE,
StandardCopyOption.REPLACE_EXISTING);
tmpSha256 = null;
Files.move(tmpBinary, binary,
StandardCopyOption.ATOMIC_MOVE,
StandardCopyOption.REPLACE_EXISTING);
tmpBinary = null;
return binary;
} catch (SphinxException e) {
throw e;
} catch (Exception e) {
throw new SphinxException("failed to download Sphinx binary at: " + binaryUri, e);
} finally {
if (tmpSha256 != null) {
try {
Files.deleteIfExists(tmpSha256);
} catch (IOException e) {
// Swallow.
}
}
if (tmpBinary != null) {
try {
Files.deleteIfExists(tmpBinary);
} catch (IOException e) {
// Swallow.
}
}
}
}
private static Path newTempExecutableFile(Path dir, String name) throws IOException {
if (osDetector.isWindows()) {
return Files.createTempFile(dir, name + '.', ".tmp");
} else {
return Files.createTempFile(
dir, name + '.', ".tmp",
PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rwxr-xr-x")));
}
}
private static Path newTempRegularFile(Path dir, String name) throws IOException {
if (osDetector.isWindows()) {
return Files.createTempFile(dir, name + '.', ".tmp");
} else {
return Files.createTempFile(
dir, name + '.', ".tmp",
PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rw-r--r--")));
}
}
private void download(URI uri, Path path) {
URL url;
try {
url = uri.toURL();
} catch (MalformedURLException e) {
throw new IllegalStateException(e);
}
for (;;) {
logger.log("Download " + url);
HttpURLConnection conn = null;
try {
conn = (HttpURLConnection) url.openConnection();
conn.setRequestProperty("Accept",
"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8");
conn.setRequestProperty("Accept-Encoding", "identity");
conn.setRequestProperty("Accept-Language", "en-US,en;q=0.5");
conn.setRequestProperty("Cache-Control", "no-cache");
conn.setRequestProperty("Pragma", "no-cache");
conn.setRequestProperty("User-Agent", USER_AGENT);
conn.setUseCaches(false);
switch (conn.getResponseCode()) {
case 301:
case 302:
case 303:
case 307:
case 308:
// Handle redirect.
final String location = conn.getHeaderField("Location");
if (location == null) {
throw new SphinxException(
"missing 'Location' header in a redirect response: " + url);
}
final URI newUri;
try {
newUri = URI.create(location);
} catch (Exception e) {
throw new SphinxException(
"invalid 'Location' header in a redirect response: " + url);
}
if (!newUri.isAbsolute()) {
// It's valid to have a relative URL in a 'Location' header,
// but we fail here to simplify the logic.
throw new SphinxException(
"relative 'Location' header in a redirect response: " + url);
}
url = newUri.toURL();
continue;
case 200:
// Handle below.
break;
default:
throw new SphinxException(
"unexpected response code '" + conn.getResponseCode() + "':" + url);
}
// Download the content into a new file.
final String contentLength = conn.getHeaderField("Content-Length");
long lastLogTimeNanos = System.nanoTime();
try (InputStream in = conn.getInputStream()) {
final byte[] buffer = new byte[65536];
long progress = 0;
try (FileOutputStream out = new FileOutputStream(path.toFile())) {
for (;;) {
final int readBytes = in.read(buffer);
if (readBytes < 0) {
break;
}
if (readBytes != 0) {
out.write(buffer, 0, readBytes);
progress += readBytes;
final long currentTimeNanos = System.nanoTime();
if (currentTimeNanos - lastLogTimeNanos >= TimeUnit.SECONDS.toNanos(1)) {
logger.log("Download " + progress + '/' +
(contentLength != null ? contentLength : "?"));
lastLogTimeNanos = currentTimeNanos;
}
}
}
}
}
return;
} catch (SphinxException e) {
throw e;
} catch (Exception e) {
throw new SphinxException("failed to download: " + url, e);
} finally {
if (conn != null) {
conn.disconnect();
}
}
}
}
private static class OsDetector extends Detector {
private String classifier;
boolean isWindows() {
return classifier().startsWith("windows");
}
String executableSuffix() {
if (isWindows()) {
return classifier() + ".exe";
} else {
return classifier();
}
}
private String classifier() {
if (classifier != null) {
return classifier;
}
final Properties properties = new Properties();
try {
detect(properties, Collections.emptyList());
} catch (DetectionException e) {
throw new SphinxException(e.getMessage());
}
return classifier = properties.getProperty(Detector.DETECTED_CLASSIFIER);
}
@Override
protected void log(String s) {}
@Override
protected void logProperty(String s, String s1) {}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy