From adf3da4aee922be77a9f7dcd5530c293b3f7f186 Mon Sep 17 00:00:00 2001
From: 0xboobface <0xboobface@gmail.com>
Date: Mon, 8 Apr 2019 15:41:09 +0200
Subject: [PATCH] Add documentation server with markdown servlet
---
client/pom.xml | 15 +
.../src/main/java/ctbrec/docs/DocServer.java | 56 +
.../java/ctbrec/docs/MarkdownServlet.java | 79 +
.../java/ctbrec/docs/StaticFileServlet.java | 37 +
.../java/ctbrec/ui/CamrecApplication.java | 9 +
.../resources/html/docs/RunningTheServer.md | 11 +
.../src/main/resources/html/docs/footer.html | 72 +
.../src/main/resources/html/docs/header.html | 95 +
client/src/main/resources/html/docs/index.md | 14 +
.../resources/html/static/freelancer.min.css | 1 +
.../vendor/bootstrap/css/bootstrap-grid.css | 1567 +++
.../bootstrap/css/bootstrap-grid.min.css | 7 +
.../vendor/bootstrap/css/bootstrap-reboot.css | 342 +
.../bootstrap/css/bootstrap-reboot.min.css | 8 +
.../static/vendor/bootstrap/css/bootstrap.css | 8981 +++++++++++++
.../vendor/bootstrap/css/bootstrap.css.map | 1 +
.../vendor/bootstrap/css/bootstrap.min.css | 7 +
.../bootstrap/css/bootstrap.min.css.map | 1 +
.../vendor/bootstrap/js/bootstrap.bundle.js | 6444 ++++++++++
.../bootstrap/js/bootstrap.bundle.js.map | 1 +
.../bootstrap/js/bootstrap.bundle.min.js | 7 +
.../bootstrap/js/bootstrap.bundle.min.js.map | 1 +
.../static/vendor/bootstrap/js/bootstrap.js | 3927 ++++++
.../vendor/bootstrap/js/bootstrap.js.map | 1 +
.../vendor/bootstrap/js/bootstrap.min.js | 7 +
.../vendor/bootstrap/js/bootstrap.min.js.map | 1 +
.../vendor/font-awesome/css/font-awesome.css | 2337 ++++
.../font-awesome/css/font-awesome.css.map | 7 +
.../font-awesome/css/font-awesome.min.css | 4 +
.../vendor/font-awesome/fonts/FontAwesome.otf | Bin 0 -> 134808 bytes
.../fonts/fontawesome-webfont.eot | Bin 0 -> 165742 bytes
.../fonts/fontawesome-webfont.svg | 2671 ++++
.../fonts/fontawesome-webfont.ttf | Bin 0 -> 165548 bytes
.../fonts/fontawesome-webfont.woff | Bin 0 -> 98024 bytes
.../fonts/fontawesome-webfont.woff2 | Bin 0 -> 77160 bytes
.../vendor/font-awesome/less/animated.less | 34 +
.../font-awesome/less/bordered-pulled.less | 25 +
.../static/vendor/font-awesome/less/core.less | 12 +
.../vendor/font-awesome/less/fixed-width.less | 6 +
.../font-awesome/less/font-awesome.less | 18 +
.../vendor/font-awesome/less/icons.less | 789 ++
.../vendor/font-awesome/less/larger.less | 13 +
.../static/vendor/font-awesome/less/list.less | 19 +
.../vendor/font-awesome/less/mixins.less | 60 +
.../static/vendor/font-awesome/less/path.less | 15 +
.../font-awesome/less/rotated-flipped.less | 20 +
.../font-awesome/less/screen-reader.less | 5 +
.../vendor/font-awesome/less/stacked.less | 20 +
.../vendor/font-awesome/less/variables.less | 800 ++
.../vendor/font-awesome/scss/_animated.scss | 34 +
.../font-awesome/scss/_bordered-pulled.scss | 25 +
.../vendor/font-awesome/scss/_core.scss | 12 +
.../font-awesome/scss/_fixed-width.scss | 6 +
.../vendor/font-awesome/scss/_icons.scss | 789 ++
.../vendor/font-awesome/scss/_larger.scss | 13 +
.../vendor/font-awesome/scss/_list.scss | 19 +
.../vendor/font-awesome/scss/_mixins.scss | 60 +
.../vendor/font-awesome/scss/_path.scss | 15 +
.../font-awesome/scss/_rotated-flipped.scss | 20 +
.../font-awesome/scss/_screen-reader.scss | 5 +
.../vendor/font-awesome/scss/_stacked.scss | 20 +
.../vendor/font-awesome/scss/_variables.scss | 800 ++
.../font-awesome/scss/font-awesome.scss | 18 +
.../jquery.easing.compatibility.js | 59 +
.../vendor/jquery-easing/jquery.easing.js | 166 +
.../vendor/jquery-easing/jquery.easing.min.js | 1 +
.../html/static/vendor/jquery/jquery.js | 10364 ++++++++++++++++
.../html/static/vendor/jquery/jquery.min.js | 2 +
.../html/static/vendor/jquery/jquery.min.map | 1 +
.../html/static/vendor/jquery/jquery.slim.js | 8269 ++++++++++++
.../static/vendor/jquery/jquery.slim.min.js | 2 +
.../static/vendor/jquery/jquery.slim.min.map | 1 +
.../magnific-popup/jquery.magnific-popup.js | 1860 +++
.../jquery.magnific-popup.min.js | 4 +
.../vendor/magnific-popup/magnific-popup.css | 351 +
75 files changed, 51463 insertions(+)
create mode 100644 client/src/main/java/ctbrec/docs/DocServer.java
create mode 100644 client/src/main/java/ctbrec/docs/MarkdownServlet.java
create mode 100644 client/src/main/java/ctbrec/docs/StaticFileServlet.java
create mode 100644 client/src/main/resources/html/docs/RunningTheServer.md
create mode 100644 client/src/main/resources/html/docs/footer.html
create mode 100644 client/src/main/resources/html/docs/header.html
create mode 100644 client/src/main/resources/html/docs/index.md
create mode 100644 client/src/main/resources/html/static/freelancer.min.css
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap-grid.css
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap-grid.min.css
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap-reboot.css
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap-reboot.min.css
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap.css
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap.css.map
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap.min.css
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/css/bootstrap.min.css.map
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.bundle.js
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.bundle.js.map
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.bundle.min.js
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.bundle.min.js.map
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.js
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.js.map
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.min.js
create mode 100644 client/src/main/resources/html/static/vendor/bootstrap/js/bootstrap.min.js.map
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/css/font-awesome.css
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/css/font-awesome.css.map
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/css/font-awesome.min.css
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/fonts/FontAwesome.otf
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/fonts/fontawesome-webfont.eot
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/fonts/fontawesome-webfont.svg
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/fonts/fontawesome-webfont.ttf
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/fonts/fontawesome-webfont.woff
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/fonts/fontawesome-webfont.woff2
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/animated.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/bordered-pulled.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/core.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/fixed-width.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/font-awesome.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/icons.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/larger.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/list.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/mixins.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/path.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/rotated-flipped.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/screen-reader.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/stacked.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/less/variables.less
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_animated.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_bordered-pulled.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_core.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_fixed-width.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_icons.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_larger.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_list.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_mixins.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_path.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_rotated-flipped.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_screen-reader.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_stacked.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/_variables.scss
create mode 100644 client/src/main/resources/html/static/vendor/font-awesome/scss/font-awesome.scss
create mode 100755 client/src/main/resources/html/static/vendor/jquery-easing/jquery.easing.compatibility.js
create mode 100755 client/src/main/resources/html/static/vendor/jquery-easing/jquery.easing.js
create mode 100755 client/src/main/resources/html/static/vendor/jquery-easing/jquery.easing.min.js
create mode 100644 client/src/main/resources/html/static/vendor/jquery/jquery.js
create mode 100644 client/src/main/resources/html/static/vendor/jquery/jquery.min.js
create mode 100644 client/src/main/resources/html/static/vendor/jquery/jquery.min.map
create mode 100644 client/src/main/resources/html/static/vendor/jquery/jquery.slim.js
create mode 100644 client/src/main/resources/html/static/vendor/jquery/jquery.slim.min.js
create mode 100644 client/src/main/resources/html/static/vendor/jquery/jquery.slim.min.map
create mode 100644 client/src/main/resources/html/static/vendor/magnific-popup/jquery.magnific-popup.js
create mode 100644 client/src/main/resources/html/static/vendor/magnific-popup/jquery.magnific-popup.min.js
create mode 100644 client/src/main/resources/html/static/vendor/magnific-popup/magnific-popup.css
diff --git a/client/pom.xml b/client/pom.xml
index 751cca31..abca8e98 100644
--- a/client/pom.xml
+++ b/client/pom.xml
@@ -82,6 +82,21 @@
org.openjfx
javafx-media
+
+ org.eclipse.jetty
+ jetty-server
+ [9.3.24.v20180605,)
+
+
+ org.eclipse.jetty
+ jetty-servlet
+ [9.3.24.v20180605,)
+
+
+ com.vladsch.flexmark
+ flexmark-all
+ 0.40.34
+
diff --git a/client/src/main/java/ctbrec/docs/DocServer.java b/client/src/main/java/ctbrec/docs/DocServer.java
new file mode 100644
index 00000000..1d1057e9
--- /dev/null
+++ b/client/src/main/java/ctbrec/docs/DocServer.java
@@ -0,0 +1,56 @@
+package ctbrec.docs;
+
+import java.net.BindException;
+
+import org.eclipse.jetty.server.Handler;
+import org.eclipse.jetty.server.HttpConfiguration;
+import org.eclipse.jetty.server.HttpConnectionFactory;
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.server.ServerConnector;
+import org.eclipse.jetty.server.handler.HandlerList;
+import org.eclipse.jetty.servlet.ServletHandler;
+import org.eclipse.jetty.servlet.ServletHolder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class DocServer {
+ private static final transient Logger LOG = LoggerFactory.getLogger(DocServer.class);
+
+ private static Server server = new Server();
+ private static volatile boolean started = false;
+
+ public synchronized static void start() throws Exception {
+ if(started) {
+ return;
+ }
+
+ server = new Server();
+
+ HttpConfiguration config = new HttpConfiguration();
+ config.setSendServerVersion(false);
+ ServerConnector http = new ServerConnector(server, new HttpConnectionFactory(config));
+ http.setPort(5689);
+ server.addConnector(http);
+
+ ServletHandler handler = new ServletHandler();
+ server.setHandler(handler);
+ HandlerList handlers = new HandlerList();
+ handlers.setHandlers(new Handler[] { handler });
+ server.setHandler(handlers);
+
+ MarkdownServlet markdownServlet = new MarkdownServlet();
+ ServletHolder holder = new ServletHolder(markdownServlet);
+ handler.addServletWithMapping(holder, "/docs/*");
+ StaticFileServlet staticFileServlet = new StaticFileServlet();
+ holder = new ServletHolder(staticFileServlet);
+ handler.addServletWithMapping(holder, "/static/*");
+
+ try {
+ server.start();
+ started = true;
+ server.join();
+ } catch (BindException e) {
+ LOG.error("Port {} is already in use", http.getPort(), e);
+ }
+ }
+}
diff --git a/client/src/main/java/ctbrec/docs/MarkdownServlet.java b/client/src/main/java/ctbrec/docs/MarkdownServlet.java
new file mode 100644
index 00000000..c93e7535
--- /dev/null
+++ b/client/src/main/java/ctbrec/docs/MarkdownServlet.java
@@ -0,0 +1,79 @@
+package ctbrec.docs;
+
+import java.io.ByteArrayOutputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.vladsch.flexmark.html.HtmlRenderer;
+import com.vladsch.flexmark.parser.Parser;
+import com.vladsch.flexmark.util.ast.Node;
+import com.vladsch.flexmark.util.options.MutableDataSet;
+
+public class MarkdownServlet extends HttpServlet {
+
+ private static final transient Logger LOG = LoggerFactory.getLogger(MarkdownServlet.class);
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+ String path = req.getRequestURI();
+ LOG.debug("Path: [{}]", path);
+ try {
+ String md = loadMarkdown(path);
+ String html = markdownToHtml(md);
+ resp.setStatus(HttpServletResponse.SC_OK);
+ resp.getWriter().println(getHeader());
+ resp.getWriter().println(html);
+ resp.getWriter().println(getFooter());
+ } catch (FileNotFoundException e) {
+ resp.setStatus(HttpServletResponse.SC_NOT_FOUND);
+ resp.setContentType("text/plain");
+ resp.getWriter().println("Hö?");
+ resp.getWriter().println();
+ }
+ }
+
+ private String markdownToHtml(String markdown) {
+ MutableDataSet options = new MutableDataSet();
+ Parser parser = Parser.builder(options).build();
+ HtmlRenderer renderer = HtmlRenderer.builder(options).build();
+ Node document = parser.parse(markdown);
+ String html = renderer.render(document);
+ return html;
+ }
+
+ private String loadMarkdown(String path) throws IOException {
+ String resource = "/html" + path;
+ return loadFile(resource);
+ }
+
+ private String loadFile(String resource) throws IOException {
+ InputStream resourceAsStream = getClass().getResourceAsStream(resource);
+ if(resourceAsStream == null) {
+ throw new FileNotFoundException();
+ }
+ ByteArrayOutputStream out = new ByteArrayOutputStream();
+ int length = 0;
+ byte[] buffer = new byte[1024];
+ while( (length = resourceAsStream.read(buffer)) >= 0 ) {
+ out.write(buffer, 0, length);
+ }
+ return new String(out.toByteArray(), "utf-8");
+ }
+
+ private String getHeader() throws IOException {
+ return loadFile("/html/docs/header.html");
+ }
+
+ private String getFooter() throws IOException {
+ return loadFile("/html/docs/footer.html");
+ }
+}
diff --git a/client/src/main/java/ctbrec/docs/StaticFileServlet.java b/client/src/main/java/ctbrec/docs/StaticFileServlet.java
new file mode 100644
index 00000000..b195a3db
--- /dev/null
+++ b/client/src/main/java/ctbrec/docs/StaticFileServlet.java
@@ -0,0 +1,37 @@
+package ctbrec.docs;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+public class StaticFileServlet extends HttpServlet {
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+ String request = req.getRequestURI();
+ serveFile(request, resp);
+ }
+
+ @Override
+ protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+ doGet(req, resp);
+ }
+
+ private void serveFile(String resource, HttpServletResponse resp) throws IOException {
+ InputStream resourceAsStream = getClass().getResourceAsStream("/html" + resource);
+ if(resourceAsStream == null) {
+ throw new FileNotFoundException();
+ }
+ OutputStream out = resp.getOutputStream();
+ int length = 0;
+ byte[] buffer = new byte[1024];
+ while( (length = resourceAsStream.read(buffer)) >= 0 ) {
+ out.write(buffer, 0, length);
+ }
+ }
+}
diff --git a/client/src/main/java/ctbrec/ui/CamrecApplication.java b/client/src/main/java/ctbrec/ui/CamrecApplication.java
index ab111385..59165e9a 100644
--- a/client/src/main/java/ctbrec/ui/CamrecApplication.java
+++ b/client/src/main/java/ctbrec/ui/CamrecApplication.java
@@ -26,6 +26,7 @@ import ctbrec.Config;
import ctbrec.Model;
import ctbrec.StringUtil;
import ctbrec.Version;
+import ctbrec.docs.DocServer;
import ctbrec.event.Event;
import ctbrec.event.EventBusHolder;
import ctbrec.event.EventHandler;
@@ -108,6 +109,14 @@ public class CamrecApplication extends Application {
}
createGui(primaryStage);
checkForUpdates();
+
+ new Thread(() -> {
+ try {
+ DocServer.start();
+ } catch (Exception e) {
+ LOG.error("Couldn't start documentation server", e);
+ }
+ }).start();
}
private void logEnvironment() {
diff --git a/client/src/main/resources/html/docs/RunningTheServer.md b/client/src/main/resources/html/docs/RunningTheServer.md
new file mode 100644
index 00000000..ca8b294b
--- /dev/null
+++ b/client/src/main/resources/html/docs/RunningTheServer.md
@@ -0,0 +1,11 @@
+How To Run The Server
+=======================
+The archive you downloaded contains a `server.bat` or `server.sh`, which can be used to start the server. On the first start, the server uses a default configuration. Once you terminate the server by pressing ctrl + c, the config is stored in your user home.
+
+On Windows that is `C:\Users\{your user name}\AppData\Roaming\ctbrec\server.json`
+
+On Linux it is `~/.config/ctbrec/server.json`
+
+On macOS it is `/Users/{your user name}/Library/Preferences/ctbrec`
+
+You can open this file in a text editor and change it to your likings. You probably only want to change httpPort and recordingsDir. Most of the other stuff is irrelevant since the server and CTB Recorder use the same config file format. When the server is running, you can connect to it with CTB Recorder by changing the setting "Record location" to "Remote".
\ No newline at end of file
diff --git a/client/src/main/resources/html/docs/footer.html b/client/src/main/resources/html/docs/footer.html
new file mode 100644
index 00000000..96fba82e
--- /dev/null
+++ b/client/src/main/resources/html/docs/footer.html
@@ -0,0 +1,72 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+