From 1f1318b8c0ba0bc472c263e54079cbaa6e303fe0 Mon Sep 17 00:00:00 2001
From: Niki Roo <niki@nikiroo.be>
Date: Wed, 20 May 2020 16:28:19 +0200
Subject: [PATCH] weblib: use templates for all html

---
 src/be/nikiroo/fanfix/library/Template.java   |   9 +-
 .../fanfix/library/WebLibraryServerHtml.java  | 254 +++++++-----------
 .../library/web/WebLibraryServerIndex.java    |   5 +
 .../fanfix/library/web/package-info.java      |   3 +
 .../templates/WebLibraryServerTemplates.java  |  36 ++-
 .../library/web/templates/package-info.java   |   3 +
 .../fanfix/library/web/templates/viewer.html  |   1 -
 7 files changed, 139 insertions(+), 172 deletions(-)
 delete mode 100644 src/be/nikiroo/fanfix/library/web/templates/viewer.html

diff --git a/src/be/nikiroo/fanfix/library/Template.java b/src/be/nikiroo/fanfix/library/Template.java
index 3536d5f..3ec9873 100644
--- a/src/be/nikiroo/fanfix/library/Template.java
+++ b/src/be/nikiroo/fanfix/library/Template.java
@@ -64,22 +64,27 @@ public class Template {
 
 			i++;
 		}
-		
+
 		InputStream in = IOUtils.openResource(location, name);
 		return new ReplaceInputStream(in, from, to);
 	}
 
 	public synchronized Template set(String key, String value) {
-		values.put(key, value);
+		values.put(key, value == null ? "" : key);
 		valuesTemplate.remove(key);
 		valuesTemplateList.remove(key);
 		return this;
 	}
 
 	public synchronized Template set(String key, Template value) {
+		if (value == null) {
+			return set(key, "");
+		}
+
 		values.remove(key);
 		valuesTemplate.put(key, value);
 		valuesTemplateList.remove(key);
+
 		return this;
 	}
 
diff --git a/src/be/nikiroo/fanfix/library/WebLibraryServerHtml.java b/src/be/nikiroo/fanfix/library/WebLibraryServerHtml.java
index 42ebead..d5ba533 100644
--- a/src/be/nikiroo/fanfix/library/WebLibraryServerHtml.java
+++ b/src/be/nikiroo/fanfix/library/WebLibraryServerHtml.java
@@ -16,7 +16,6 @@ import javax.net.ssl.SSLServerSocketFactory;
 
 import be.nikiroo.fanfix.Instance;
 import be.nikiroo.fanfix.bundles.Config;
-import be.nikiroo.fanfix.bundles.UiConfig;
 import be.nikiroo.fanfix.data.Chapter;
 import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Paragraph;
@@ -543,14 +542,13 @@ abstract class WebLibraryServerHtml implements Runnable {
 
 			String first, previous, next, last;
 
-			String viewer = "";
-
-			String disabledLeft = "";
-			String disabledRight = "";
-			String disabledZoomReal = "";
-			String disabledZoomWidth = "";
-			String disabledZoomHeight = "";
+			boolean disabledLeft = false;
+			boolean disabledRight = false;
+			boolean disabledZoomReal = false;
+			boolean disabledZoomWidth = false;
+			boolean disabledZoomHeight = false;
 
+			Template viewerItem = null;
 			if (paragraph <= 0) {
 				first = WebLibraryUrls.getViewUrl(luid, 0, null);
 				previous = WebLibraryUrls.getViewUrl(luid,
@@ -561,42 +559,37 @@ abstract class WebLibraryServerHtml implements Runnable {
 				last = WebLibraryUrls.getViewUrl(luid,
 						story.getChapters().size(), null);
 
-				String desc = "";
+				Template desc = null;
 				if (chapter <= 0) {
-					StringBuilder desclines = new StringBuilder();
+					List<Template> desclines = new ArrayList<Template>();
 					Map<String, String> details = BasicLibrary
 							.getMetaDesc(story.getMeta());
 					for (String key : details.keySet()) {
-						desclines.append(getTemplate("viewer.descline") //
-								.replace("${key}", key) //
-								.replace("${value}", details.get(key)) //
-						);
+						desclines.add(templates.viewerDescline(key,
+								details.get(key)));
 					}
 
-					desc = getTemplate("viewer.desc") //
-							.replace("${title}", story.getMeta().getTitle()) //
-							.replace("${href}", next) //
-							.replace("${cover}",
-									WebLibraryUrls.getStoryUrlCover(luid)) //
-							.replace("${details}", desclines.toString()) //
-					;
+					desc = templates.viewerDesc( //
+							story.getMeta().getTitle(), //
+							next, //
+							WebLibraryUrls.getStoryUrlCover(luid), //
+							desclines //
+					);
 				}
 
-				viewer = getTemplate("viewer.text") //
-						.replace("${desc}", desc) //
-				;
+				String content;
 				if (chap.getParagraphs().size() <= 0) {
-					viewer = viewer.replace("${content}",
-							"No content provided.");
+					content = "No content provided.";
 				} else {
-					viewer = viewer.replace("${content}",
-							new TextOutput(false).convert(chap, chapter > 0));
+					content = new TextOutput(false).convert(chap, chapter > 0);
 				}
 
+				viewerItem = templates.viewerText(desc, content);
+
 				if (chapter <= 0)
-					disabledLeft = " disabled='disbaled'";
+					disabledLeft = true;
 				if (chapter >= story.getChapters().size())
-					disabledRight = " disabled='disbaled'";
+					disabledRight = true;
 			} else {
 				first = WebLibraryUrls.getViewUrl(luid, chapter, 1);
 				previous = WebLibraryUrls.getViewUrl(luid, chapter,
@@ -607,13 +600,13 @@ abstract class WebLibraryServerHtml implements Runnable {
 						chap.getParagraphs().size());
 
 				if (paragraph <= 1)
-					disabledLeft = " disabled='disbaled'";
+					disabledLeft = true;
 				if (paragraph >= chap.getParagraphs().size())
-					disabledRight = " disabled='disbaled'";
+					disabledRight = true;
 
 				// First -> previous *chapter*
 				if (chapter > 0)
-					disabledLeft = "";
+					disabledLeft = false;
 				first = WebLibraryUrls.getViewUrl(luid,
 						(Math.max(chapter - 1, 0)), null);
 				if (paragraph <= 1) {
@@ -631,56 +624,47 @@ abstract class WebLibraryServerHtml implements Runnable {
 
 				if (para.getType() == ParagraphType.IMAGE) {
 					String zoomStyle = "max-width: 100%;";
-					disabledZoomWidth = " disabled='disabled'";
+					disabledZoomWidth = true;
 					String zoomOption = cookies.get("zoom");
 					if (zoomOption != null && !zoomOption.isEmpty()) {
 						if (zoomOption.equals("real")) {
 							zoomStyle = "";
-							disabledZoomWidth = "";
-							disabledZoomReal = " disabled='disabled'";
+							disabledZoomWidth = false;
+							disabledZoomReal = true;
 						} else if (zoomOption.equals("width")) {
 							zoomStyle = "max-width: 100%;";
 						} else if (zoomOption.equals("height")) {
 							// see height of navbar + optionbar
 							zoomStyle = "max-height: calc(100% - 128px);";
-							disabledZoomWidth = "";
-							disabledZoomHeight = " disabled='disabled'";
+							disabledZoomWidth = false;
+							disabledZoomHeight = true;
 						}
 					}
 
-					viewer = getTemplate("viewer.image") //
-							.replace("${href}", next) //
-							.replace("${zoomStyle}", zoomStyle) //
-							.replace("${src}", WebLibraryUrls.getStoryUrl(luid,
-									chapter, paragraph)) //
-					;
+					viewerItem = templates.viewerImage(WebLibraryUrls
+							.getStoryUrl(luid, chapter, paragraph), next,
+							zoomStyle);
 				} else {
-					viewer = getTemplate("viewer.text") //
-							.replace("${desc}", "") //
-							.replace("${content}",
-									new TextOutput(false).convert(para)) //
-					;
+					viewerItem = templates.viewerText(null,
+							new TextOutput(false).convert(para));
 				}
 			}
 
-			// List of chap/para links
-			StringBuilder links = new StringBuilder();
-			links.append(getTemplate("viewer.link") //
-					.replace("${link}",
-							WebLibraryUrls.getViewUrl(luid, 0, null)) //
-					.replace("${class}",
-							paragraph == 0 && chapter == 0 ? "selected" : "") //
-					.replace("${name}", "Description") //
-			);
+			// List of chap/para links for navbar
+
+			List<Template> links = new ArrayList<Template>();
+			links.add(templates.viewerLink( //
+					"Description", //
+					WebLibraryUrls.getViewUrl(luid, 0, null), //
+					paragraph == 0 && chapter == 0 //
+			));
 			if (paragraph > 0) {
 				for (int i = 1; i <= chap.getParagraphs().size(); i++) {
-					links.append(getTemplate("viewer.link") //
-							.replace("${link}",
-									WebLibraryUrls.getViewUrl(luid, chapter, i)) //
-							.replace("${class}",
-									paragraph == i ? "selected" : "") //
-							.replace("${name}", "Image " + i) //
-					);
+					links.add(templates.viewerLink( //
+							"Image " + i, //
+							WebLibraryUrls.getViewUrl(luid, chapter, i), //
+							paragraph == i //
+					));
 				}
 			} else {
 				int i = 1;
@@ -690,81 +674,63 @@ abstract class WebLibraryServerHtml implements Runnable {
 						chapName += ": " + c.getName();
 					}
 
-					links.append(getTemplate("viewer.link") //
-							.replace("${link}",
-									WebLibraryUrls.getViewUrl(luid, i, null)) //
-							.replace("${class}", chapter == i ? "selected" : "") //
-							.replace("${name}", chapName) //
-					);
+					links.add(templates.viewerLink( //
+							chapName, //
+							WebLibraryUrls.getViewUrl(luid, i, null), //
+							chapter == i //
+					));
 
 					i++;
 				}
 			}
 
+			// Navbar
+
+			Template navbar = templates.viewerNavbar( //
+					paragraph > 0 ? paragraph : chapter, //
+					links, //
+					first, //
+					previous, //
+					next, //
+					last, //
+					disabledLeft, //
+					disabledLeft, //
+					disabledRight, //
+					disabledRight //
+			);
+
 			// Buttons on the optionbar
 
-			StringBuilder buttons = new StringBuilder();
-			buttons.append(getTemplate("viewer.optionbar.button") //
-					.replace("${disabled}", "") //
-					.replace("${class}", "back") //
-					.replace("${href}", "/") //
-					.replace("${value}", "Back") //
-			);
+			List<Template> buttons = new ArrayList<Template>();
+			buttons.add(templates.viewerOptionbarButton( //
+					"Back", "/", "back", false));
 			if (paragraph > 0) {
-				buttons.append(getTemplate("viewer.optionbar.button") //
-						.replace("${disabled}", disabledZoomReal) //
-						.replace("${class}", "zoomreal") //
-						.replace("${href}",
-								uri + "?optionName=zoom&optionValue=real") //
-						.replace("${value}", "1:1") //
-				);
-				buttons.append(getTemplate("viewer.optionbar.button") //
-						.replace("${disabled}", disabledZoomWidth) //
-						.replace("${class}", "zoomwidth") //
-						.replace("${href}",
-								uri + "?optionName=zoom&optionValue=width") //
-						.replace("${value}", "Width") //
-				);
-				buttons.append(getTemplate("viewer.optionbar.button") //
-						.replace("${disabled}", disabledZoomHeight) //
-						.replace("${class}", "zoomheight") //
-						.replace("${href}",
-								uri + "?optionName=zoom&optionValue=height") //
-						.replace("${value}", "Height") //
-				);
+				buttons.add(templates.viewerOptionbarButton( //
+						"1:1", uri + "?optionName=zoom&optionValue=real",
+						"zoomreal", disabledZoomReal));
+				buttons.add(templates.viewerOptionbarButton( //
+						"Width", uri + "?optionName=zoom&optionValue=width",
+						"zoomwidth", disabledZoomWidth));
+				buttons.add(templates.viewerOptionbarButton( //
+						"Height", uri + "?optionName=zoom&optionValue=height",
+						"zoomHeight", disabledZoomHeight));
 			}
 
-			// Full content
+			// Optionbar
 
-			StringBuilder builder = new StringBuilder();
-
-			builder.append(getTemplateIndexPreBanner(false));
-
-			builder.append(getTemplate("viewer.navbar") //
-					.replace("${disabledFirst}", disabledLeft) //
-					.replace("${disabledPrevious}", disabledLeft) //
-					.replace("${disabledNext}", disabledRight) //
-					.replace("${disabledLast}", disabledRight) //
-					.replace("${hrefFirst}", first) //
-					.replace("${hrefPrevious}", previous) //
-					.replace("${hrefNext}", next) //
-					.replace("${hrefLast}", last) //
-					.replace("${current}",
-							"" + (paragraph > 0 ? paragraph : chapter)) //
-					.replace("${links}", links.toString()) //
+			Template optionbar = templates.viewerOptionbar( //
+					(paragraph > 0) ? 4 : 1, //
+					buttons //
 			);
 
-			builder.append(viewer);
-
-			builder.append(getTemplate("viewer.optionbar") //
-					.replace("${classSize}", (paragraph > 0 ? "s4" : "s1")) //
-					.replace("${buttons}", buttons.toString()) //
-			);
-
-			builder.append(getTemplate("index.post"));
+			// Full content
 
-			return NanoHTTPD.newFixedLengthResponse(Status.OK,
-					NanoHTTPD.MIME_HTML, builder.toString());
+			return newInputStreamResponse(NanoHTTPD.MIME_HTML, //
+					templates.index(false, Arrays.asList( //
+							navbar, //
+							viewerItem, //
+							optionbar //
+					)).read());
 		} catch (IOException e) {
 			Instance.getInstance().getTraceHandler()
 					.error(new IOException("Cannot get image: " + uri, e));
@@ -780,40 +746,4 @@ abstract class WebLibraryServerHtml implements Runnable {
 		}
 		return NanoHTTPD.newChunkedResponse(Status.OK, mimeType, in);
 	}
-
-	private String getTemplateIndexPreBanner(boolean banner)
-			throws IOException {
-		String favicon = "favicon.ico";
-		String icon = Instance.getInstance().getUiConfig()
-				.getString(UiConfig.PROGRAM_ICON);
-		if (icon != null) {
-			favicon = "icon_" + icon.replace("-", "_") + ".png";
-		}
-
-		String html = getTemplate("index.pre") //
-				.replace("${title}", "Fanfix") //
-				.replace("${favicon}", favicon) //
-		;
-
-		if (banner) {
-			html += getTemplate("index.banner") //
-					.replace("${favicon}", favicon) //
-					.replace("${version}",
-							Version.getCurrentVersion().toString()) //
-			;
-		}
-
-		return html;
-	}
-
-	private String getTemplate(String template) throws IOException {
-		// TODO: check if it is "slow" -> map cache
-		InputStream in = IOUtils.openResource(WebLibraryServerTemplates.class,
-				template + ".html");
-		try {
-			return IOUtils.readSmallStream(in);
-		} finally {
-			in.close();
-		}
-	}
 }
diff --git a/src/be/nikiroo/fanfix/library/web/WebLibraryServerIndex.java b/src/be/nikiroo/fanfix/library/web/WebLibraryServerIndex.java
index 15c371b..b6825ec 100644
--- a/src/be/nikiroo/fanfix/library/web/WebLibraryServerIndex.java
+++ b/src/be/nikiroo/fanfix/library/web/WebLibraryServerIndex.java
@@ -1,4 +1,9 @@
 package be.nikiroo.fanfix.library.web;
 
+/**
+ * Empty class used to find the correct package.
+ * 
+ * @author niki
+ */
 public class WebLibraryServerIndex {
 }
diff --git a/src/be/nikiroo/fanfix/library/web/package-info.java b/src/be/nikiroo/fanfix/library/web/package-info.java
index 69bff54..cf9c0c8 100644
--- a/src/be/nikiroo/fanfix/library/web/package-info.java
+++ b/src/be/nikiroo/fanfix/library/web/package-info.java
@@ -1 +1,4 @@
+/**
+ * This package is only used to store web resources for the Fanfix web server.
+ */
 package be.nikiroo.fanfix.library.web;
\ No newline at end of file
diff --git a/src/be/nikiroo/fanfix/library/web/templates/WebLibraryServerTemplates.java b/src/be/nikiroo/fanfix/library/web/templates/WebLibraryServerTemplates.java
index 31abe69..59e7020 100644
--- a/src/be/nikiroo/fanfix/library/web/templates/WebLibraryServerTemplates.java
+++ b/src/be/nikiroo/fanfix/library/web/templates/WebLibraryServerTemplates.java
@@ -7,9 +7,19 @@ import be.nikiroo.fanfix.bundles.UiConfig;
 import be.nikiroo.fanfix.library.Template;
 import be.nikiroo.utils.Version;
 
+/**
+ * Utility class to retrieve and fill HTML templates for Fanfix web server.
+ * 
+ * @author niki
+ */
 public class WebLibraryServerTemplates {
 	static private WebLibraryServerTemplates instance = new WebLibraryServerTemplates();
 
+	/**
+	 * Get the (unique) instance of this {@link WebLibraryServerTemplates}.
+	 * 
+	 * @return the (unique) instance
+	 */
 	static public WebLibraryServerTemplates getInstance() {
 		return instance;
 	}
@@ -110,9 +120,21 @@ public class WebLibraryServerTemplates {
 		;
 	}
 
-	public Template viewer(Template browser, List<Template> booklines) {
-		// TODO
-		return null;
+	public Template viewerDesc(String title, String href, String cover,
+			List<Template> desclines) {
+		return new Template(getClass(), "viewer.desc.html") //
+				.set("title", title) //
+				.set("href", href) //
+				.set("cover", cover) //
+				.set("details", desclines) //
+		;
+	}
+
+	public Template viewerDescline(String key, String value) {
+		return new Template(getClass(), "viewer.descline.html") //
+				.set("key", key) //
+				.set("value", value) //
+		;
 	}
 
 	public Template viewerImage(String src, String href, String zoomStyle) {
@@ -123,17 +145,17 @@ public class WebLibraryServerTemplates {
 		;
 	}
 
-	public Template viewerText(List<Template> desc, List<Template> content) {
+	public Template viewerText(Template desc, String content) {
 		return new Template(getClass(), "viewer.text.html") //
 				.set("desc", desc) //
 				.set("content", content) //
 		;
 	}
 
-	public Template viewerLink(String name, String link, String className) {
+	public Template viewerLink(String name, String link, boolean selected) {
 		return new Template(getClass(), "viewer.link.html") //
 				.set("link", link) //
-				.set("class", className) //
+				.set("class", selected ? "selected" : "") //
 				.set("name", name) //
 		;
 	}
@@ -158,7 +180,7 @@ public class WebLibraryServerTemplates {
 		;
 	}
 
-	// numberOfButtons = 4 or 1 or the moment
+	// supported numberOfButtons = 4 or 1 or the moment
 	public Template viewerOptionbar(int numberOfButtons,
 			List<Template> buttons) {
 		return new Template(getClass(), "viewer.optionbar.html") //
diff --git a/src/be/nikiroo/fanfix/library/web/templates/package-info.java b/src/be/nikiroo/fanfix/library/web/templates/package-info.java
index 5d4f3b2..7cf4689 100644
--- a/src/be/nikiroo/fanfix/library/web/templates/package-info.java
+++ b/src/be/nikiroo/fanfix/library/web/templates/package-info.java
@@ -1 +1,4 @@
+/**
+ * This package is used by the Fanfix web server to get HTML templates.
+ */
 package be.nikiroo.fanfix.library.web.templates;
\ No newline at end of file
diff --git a/src/be/nikiroo/fanfix/library/web/templates/viewer.html b/src/be/nikiroo/fanfix/library/web/templates/viewer.html
deleted file mode 100644
index f4b4215..0000000
--- a/src/be/nikiroo/fanfix/library/web/templates/viewer.html
+++ /dev/null
@@ -1 +0,0 @@
-${browser}${viewer}
\ No newline at end of file
-- 
2.27.0