From 60663817b1987b58e0de567c86a778b8ab35a53f Mon Sep 17 00:00:00 2001
From: Bert Frees <bertfrees@gmail.com>
Date: Thu, 6 Jun 2019 14:53:42 +0200
Subject: [PATCH] Create two versions: a "standalone" version and a normal
 version

Only the "standalone" version includes the binaries and tables.
---
 pom.xml                                       |  45 ++++--
 .../{test-jar => test-standalone-jar}/pom.xml |   5 +-
 .../org/liblouis/EmbeddedTableResolver.java   | 152 ++++++++++++++++++
 src/main/java/org/liblouis/Louis.java         | 151 ++---------------
 4 files changed, 202 insertions(+), 151 deletions(-)
 rename src/it/{test-jar => test-standalone-jar}/pom.xml (92%)
 create mode 100644 src/main/java/org/liblouis/EmbeddedTableResolver.java

diff --git a/pom.xml b/pom.xml
index 43030fb..a4b577e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -134,23 +134,18 @@
         <artifactId>build-helper-maven-plugin</artifactId>
         <version>3.0.0</version>
         <executions>
+          <!--
+              Add the binaries to the test classpath in order to make the tests work. Adding them to
+              the (standalone) JAR is done in the maven-bundle-plugin.
+          -->
           <execution>
-            <id>add-resources</id>
-            <phase>generate-resources</phase>
+            <id>add-test-resources</id>
+            <phase>generate-test-resources</phase>
             <goals>
-              <goal>add-resource</goal>
+              <goal>add-test-resource</goal>
             </goals>
             <configuration>
               <resources>
-                <resource>
-                  <directory>target/dependency/share/liblouis/tables</directory>
-                  <targetPath>org/liblouis/resource-files/tables</targetPath>
-                </resource>
-                <!--
-                    For MacOS include only 64-bit version because JNA only looks in one path, namely
-                    /darwin/liblouis.dylib. The alternative is to build a multi-architecture binary,
-                    or to check the architecture in Louis.java and specify an exact path in the JAR.
-                -->
                 <resource>
                   <directory>target/dependency/lib/x86_64-MacOSX-gpp/shared</directory>
                   <includes>
@@ -194,6 +189,10 @@
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
         <configuration>
+          <excludes>
+            <!-- part of integration-test -->
+            <exclude>org/liblouis/DefaultTablesTest.java</exclude>
+          </excludes>
           <forkMode>pertest</forkMode>
           <systemPropertyVariables>
             <jna.nosys>true</jna.nosys>
@@ -212,6 +211,28 @@
             <addMavenDescriptor>false</addMavenDescriptor>
           </archive>
         </configuration>
+        <executions>
+          <execution>
+            <id>bundle-standalone</id>
+            <phase>package</phase>
+            <goals>
+              <goal>bundle</goal>
+            </goals>
+            <configuration>
+              <classifier>standalone</classifier>
+              <instructions>
+                <Include-Resource>
+                  org/liblouis/resource-files/tables=target/dependency/share/liblouis/tables,
+                  darwin/liblouis.dylib=target/dependency/lib/x86_64-MacOSX-gpp/shared/liblouis.dylib,
+                  linux-x86/liblouis.so=target/dependency/lib/i386-Linux-gpp/shared/liblouis.so,
+                  linux-x86-64/liblouis.so=target/dependency/lib/amd64-Linux-gpp/shared/liblouis.so,
+                  win32-x86/liblouis.dll=target/dependency/bin/i686-w64-mingw32-gpp/liblouis.dll,
+                  win32-x86-64/liblouis.dll=target/dependency/bin/x86_64-w64-mingw32-gpp/liblouis.dll
+                </Include-Resource>
+              </instructions>
+            </configuration>
+          </execution>
+        </executions>
       </plugin>
       <!--
           run the same tests but from another project
diff --git a/src/it/test-jar/pom.xml b/src/it/test-standalone-jar/pom.xml
similarity index 92%
rename from src/it/test-jar/pom.xml
rename to src/it/test-standalone-jar/pom.xml
index cca5bea..35a212a 100644
--- a/src/it/test-jar/pom.xml
+++ b/src/it/test-standalone-jar/pom.xml
@@ -3,8 +3,8 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
-	<groupId>test-jar</groupId>
-	<artifactId>test-jar</artifactId>
+	<groupId>test-standalone-jar</groupId>
+	<artifactId>test-standalone-jar</artifactId>
 	<version>0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 	<dependencies>
@@ -12,6 +12,7 @@
 			<groupId>org.liblouis</groupId>
 			<artifactId>liblouis-java</artifactId>
 			<version>${liblouis-java.version}</version>
+			<classifier>standalone</classifier>
 		</dependency>
 		<dependency>
 			<groupId>junit</groupId>
diff --git a/src/main/java/org/liblouis/EmbeddedTableResolver.java b/src/main/java/org/liblouis/EmbeddedTableResolver.java
new file mode 100644
index 0000000..5b886b3
--- /dev/null
+++ b/src/main/java/org/liblouis/EmbeddedTableResolver.java
@@ -0,0 +1,152 @@
+package org.liblouis;
+
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.InputStream;
+import java.io.IOException;
+import java.net.URI;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.attribute.BasicFileAttributes;
+import java.nio.file.attribute.BasicFileAttributeView;
+import static java.nio.file.Files.walkFileTree;
+import java.nio.file.Files;
+import java.nio.file.FileSystem;
+import java.nio.file.FileSystemNotFoundException;
+import java.nio.file.FileSystems;
+import java.nio.file.FileVisitOption;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Path;
+import java.nio.file.NoSuchFileException;
+import java.nio.file.SimpleFileVisitor;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.EnumSet;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.liblouis.Louis.asFile;
+import static org.liblouis.Louis.asURL;
+
+/**
+ * Default table resolver implementation that looks for tables inside this JAR and falls back to the file system
+ */
+class EmbeddedTableResolver implements TableResolver {
+	
+	private final Map<String,URL> tables;
+	private final Set<String> tablePaths;
+	private final Map<String,URL> aggregatorTables = new HashMap<String,URL>();
+	
+	EmbeddedTableResolver(org.slf4j.Logger logger) {
+		tables = new HashMap<String,URL>();
+		for (String table : listResources("org/liblouis/resource-files/tables"))
+			tables.put(table, Louis.class.getResource("resource-files/tables/" + table));
+		tablePaths = Collections.unmodifiableSet(tables.keySet());
+		logger.debug("Using default tables");
+		logger.trace("Table files: " + tablePaths);
+	}
+	
+	public URL resolve(String table, URL base) {
+		// if we are resolving an include rule from a generated aggregator table, resolve without base
+		if (aggregatorTables.containsValue(base))
+			base = null;
+		if (base == null || tables.containsValue(base)) {
+			if (tables.containsKey(table))
+				return tables.get(table);
+		}
+		// if it is a comma separated table list, create a single file that includes all the sub-tables
+		if (base == null && table.contains(",")) {
+			if (aggregatorTables.containsKey(table))
+				return aggregatorTables.get(table);
+			StringBuilder b = new StringBuilder();
+			for (String s : table.split(","))
+				b.append("include ").append(s.replaceAll("\\\\", "\\\\\\\\")).append('\n');
+			InputStream in = new ByteArrayInputStream(b.toString().getBytes(StandardCharsets.UTF_8));
+			try {
+				File f = File.createTempFile("liblouis-java-", ".tbl");
+				f.delete();
+				Files.copy(in, f.toPath());
+				f.deleteOnExit();
+				URL u = asURL(f);
+				aggregatorTables.put(table, u);
+				return u;
+			} catch (IOException e) {
+				throw new RuntimeException(e); // should not happen
+			}
+		}
+		// try file system
+		if (base != null && base.toString().startsWith("file:")) {
+			File f = base.toString().endsWith("/")
+				? new File(asFile(base), table)
+				: new File(asFile(base).getParentFile(), table);
+			if (f.exists())
+				return asURL(f);
+		} else if (base == null) {
+			File f = new File(table);
+			if (f.exists())
+				return asURL(f);
+		}
+		return null; // table cannot be resolved
+	}
+	
+	public Set<String> list() {
+		return tablePaths;
+	}
+	
+	private static Iterable<String> listResources(final String directory) {
+		File jarFile = asFile(Louis.class.getProtectionDomain().getCodeSource().getLocation());
+		if (!jarFile.exists())
+			throw new RuntimeException();
+		else if (jarFile.isDirectory()) {
+			File d = new File(jarFile, directory);
+			if (!d.exists())
+				throw new RuntimeException("directory does not exist");
+			else if (!d.isDirectory())
+				throw new RuntimeException("is not a directory");
+			else {
+				List<String> resources = new ArrayList<String>();
+				for (File f : d.listFiles())
+					resources.add(f.getName() + (f.isDirectory() ? "/" : ""));
+				return resources; }}
+		else {
+			FileSystem fs; {
+				try {
+					fs = FileSystems.newFileSystem(URI.create("jar:" + jarFile.toURI()),
+					                               Collections.<String,Object>emptyMap()); }
+				catch (IOException e) {
+					throw new RuntimeException(e); }}
+			try {
+				Path d = fs.getPath("/" + directory);
+				BasicFileAttributes a; {
+					try {
+						a = Files.getFileAttributeView(d, BasicFileAttributeView.class).readAttributes(); }
+					catch (NoSuchFileException e) {
+						throw new RuntimeException("directory does not exist"); }
+					catch (FileSystemNotFoundException e) {
+						throw new RuntimeException(e); }
+					catch (IOException e) {
+						throw new RuntimeException(e); }}
+				if (!a.isDirectory())
+					throw new RuntimeException("is not a directory");
+				final List<String> resources = new ArrayList<String>();
+				try {
+					walkFileTree(d, EnumSet.noneOf(FileVisitOption.class), 1, new SimpleFileVisitor<Path>() {
+							public FileVisitResult visitFile(Path f, BasicFileAttributes _) throws IOException {
+								resources.add(""+f.getFileName());
+								return FileVisitResult.CONTINUE; }}); }
+				catch (NoSuchFileException e) {
+					throw new RuntimeException(e); }
+				catch (IOException e) {
+					throw new RuntimeException(e); }
+				return resources; }
+			finally {
+				try {
+					fs.close(); }
+				catch (IOException e) {
+					throw new RuntimeException(e); }
+			}
+		}
+	}
+}
diff --git a/src/main/java/org/liblouis/Louis.java b/src/main/java/org/liblouis/Louis.java
index 586b49b..d28cb30 100644
--- a/src/main/java/org/liblouis/Louis.java
+++ b/src/main/java/org/liblouis/Louis.java
@@ -1,36 +1,17 @@
 package org.liblouis;
 
-import java.io.BufferedReader;
-import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.net.URLDecoder;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.attribute.BasicFileAttributes;
-import java.nio.file.attribute.BasicFileAttributeView;
-import static java.nio.file.Files.walkFileTree;
 import java.nio.file.Files;
-import java.nio.file.FileSystem;
-import java.nio.file.FileSystemNotFoundException;
-import java.nio.file.FileSystems;
-import java.nio.file.FileVisitOption;
-import java.nio.file.FileVisitResult;
-import java.nio.file.Path;
-import java.nio.file.NoSuchFileException;
-import java.nio.file.SimpleFileVisitor;
-import java.util.ArrayList;
 import java.util.Collections;
-import java.util.Enumeration;
-import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.HashSet;
-import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
@@ -209,7 +190,7 @@ static synchronized String findTable(String query) {
 	}
 	
 	private static void lazyIndexTables(LouisLibrary lib) {
-		if (!tablesAreIndexed) {
+		if (!tablesAreIndexed && tableResolver != null) {
 			Set<String> allFiles = tableResolver.list();
 			logger.debug("Indexing tables");
 			lib.lou_indexTables(allFiles.toArray(new String[allFiles.size()]));
@@ -218,6 +199,7 @@ private static void lazyIndexTables(LouisLibrary lib) {
 	}
 	
 	private static LouisLibrary INSTANCE;
+	private static boolean standalone = true;
 	
 	static synchronized LouisLibrary getLibrary() {
 		if (INSTANCE == null) {
@@ -228,7 +210,9 @@ static synchronized LouisLibrary getLibrary() {
 						Platform.isWindows() ? "liblouis" : "louis", // otherwise we have to rename the DLL files which
 						                                             // is not so easy to do in Maven
 						Louis.class.getClassLoader()); }
-				catch (IOException e) {}
+				catch (IOException e) {
+					// binaries are only included in standalone version
+				}
 			}
 			try {
 				String name = (libraryPath != null) ? libraryPath.getCanonicalPath() : "louis";
@@ -247,71 +231,19 @@ static synchronized LouisLibrary getLibrary() {
 						catch (IOException e) { /* ignore */ }
 			}
 		}
-		if (tableResolver == null) {
-			// default table resolver implementation that looks for tables inside this JAR and falls back to the file system
-			setTableResolver(new TableResolver() {
-					private final Map<String,URL> tables;
-					private final Set<String> tablePaths; {
-						tables = new HashMap<String,URL>();
-						for (String table : listResources("org/liblouis/resource-files/tables"))
-							tables.put(table, Louis.class.getResource("resource-files/tables/" + table));
-						tablePaths = Collections.unmodifiableSet(tables.keySet());
-						logger.debug("Using default tables");
-						logger.trace("Table files: " + tablePaths);
-					}
-					private final Map<String,URL> aggregatorTables = new HashMap<String,URL>();
-					public URL resolve(String table, URL base) {
-						// if we are resolving an include rule from a generated aggregator table, resolve without base
-						if (aggregatorTables.containsValue(base))
-							base = null;
-						if (base == null || tables.containsValue(base)) {
-							if (tables.containsKey(table))
-								return tables.get(table);
-						}
-						// if it is a comma separated table list, create a single file that includes all the sub-tables
-						if (base == null && table.contains(",")) {
-							if (aggregatorTables.containsKey(table))
-								return aggregatorTables.get(table);
-							StringBuilder b = new StringBuilder();
-							for (String s : table.split(","))
-								b.append("include ").append(s.replaceAll("\\\\", "\\\\\\\\")).append('\n');
-							InputStream in = new ByteArrayInputStream(b.toString().getBytes(StandardCharsets.UTF_8));
-							try {
-								File f = File.createTempFile("liblouis-java-", ".tbl");
-								f.delete();
-								Files.copy(in, f.toPath());
-								f.deleteOnExit();
-								URL u = asURL(f);
-								aggregatorTables.put(table, u);
-								return u;
-							} catch (IOException e) {
-								throw new RuntimeException(e); // should not happen
-							}
-						}
-						// try file system
-						if (base != null && base.toString().startsWith("file:")) {
-							File f = base.toString().endsWith("/")
-								? new File(asFile(base), table)
-								: new File(asFile(base).getParentFile(), table);
-							if (f.exists())
-								return asURL(f);
-						} else if (base == null) {
-							File f = new File(table);
-							if (f.exists())
-								return asURL(f);
-						}
-						return null; // table cannot be resolved
-					}
-					public Set<String> list() {
-						return tablePaths;
-					}
-				}
-			);
+		if (tableResolver == null && standalone) {
+			try {
+				setTableResolver(new EmbeddedTableResolver(logger)); }
+			catch (Throwable e) {
+				// tables are only included in standalone version
+				// if tables are not present it will result in an exception in EmbeddedTableResolver.listResources
+				standalone = false;
+			}
 		}
 		if (logCallback == null)
 			// pass on log messages to SLF4J
 			setLogger(Slf4jLogger.INSTANCE);
-		if (!tableResolverIsRegistered) {
+		if (lou_tableResolver != null && !tableResolverIsRegistered) {
 			INSTANCE.lou_registerTableResolver(lou_tableResolver);
 			tableResolverIsRegistered = true;
 			tablesAreIndexed = false;
@@ -438,61 +370,6 @@ static URL asURL(File file) {
 		}
 	}
 	
-	private static Iterable<String> listResources(final String directory) {
-		File jarFile = asFile(Louis.class.getProtectionDomain().getCodeSource().getLocation());
-		if (!jarFile.exists())
-			throw new RuntimeException();
-		else if (jarFile.isDirectory()) {
-			File d = new File(jarFile, directory);
-			if (!d.exists())
-				throw new RuntimeException("directory does not exist");
-			else if (!d.isDirectory())
-				throw new RuntimeException("is not a directory");
-			else {
-				List<String> resources = new ArrayList<String>();
-				for (File f : d.listFiles())
-					resources.add(f.getName() + (f.isDirectory() ? "/" : ""));
-				return resources; }}
-		else {
-			FileSystem fs; {
-				try {
-					fs = FileSystems.newFileSystem(URI.create("jar:" + jarFile.toURI()),
-					                               Collections.<String,Object>emptyMap()); }
-				catch (IOException e) {
-					throw new RuntimeException(e); }}
-			try {
-				Path d = fs.getPath("/" + directory);
-				BasicFileAttributes a; {
-					try {
-						a = Files.getFileAttributeView(d, BasicFileAttributeView.class).readAttributes(); }
-					catch (NoSuchFileException e) {
-						throw new RuntimeException("directory does not exist"); }
-					catch (FileSystemNotFoundException e) {
-						throw new RuntimeException(e); }
-					catch (IOException e) {
-						throw new RuntimeException(e); }}
-				if (!a.isDirectory())
-					throw new RuntimeException("is not a directory");
-				final List<String> resources = new ArrayList<String>();
-				try {
-					walkFileTree(d, EnumSet.noneOf(FileVisitOption.class), 1, new SimpleFileVisitor<Path>() {
-							public FileVisitResult visitFile(Path f, BasicFileAttributes _) throws IOException {
-								resources.add(""+f.getFileName());
-								return FileVisitResult.CONTINUE; }}); }
-				catch (NoSuchFileException e) {
-					throw new RuntimeException(e); }
-				catch (IOException e) {
-					throw new RuntimeException(e); }
-				return resources; }
-			finally {
-				try {
-					fs.close(); }
-				catch (IOException e) {
-					throw new RuntimeException(e); }
-			}
-		}
-	}
-	
 	private static final org.slf4j.Logger logger = LoggerFactory.getLogger(Louis.class);
 	
 	private static class Slf4jLogger implements Logger {