Feat Don't log to stderr / stdout

README.md

@@ -9,7 +9,7 @@ easily comprehensible for the user and allows an intuitive manual correction if
 The PAGE XML format is used to support integration into existing OCR workflows. 
 Evaluations showed that LAREX provides an efficient and flexible way to segment pages of early printed books.
 
-Please feel free to visit the [tool homepage](https://www.uni-wuerzburg.de/zpd/larex/). A short user manual is available [here](http://www.is.informatik.uni-wuerzburg.de/fileadmin/10030600/Mitarbeiter/Reul_Christian/Projects/Layout_Analysis/LAREX_Quick_Guide.pdf).
+Please feel free to visit the [tool homepage](https://www.uni-wuerzburg.de/zpd/larex/). A short user manual is available [here](https://www.ocr4all.org/guide/user-guide/workflow#segmentation-%E2%80%93-larex).
 
 ## Table of Contents
 - [Installation](#installation)

pom.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0"
-    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">
+    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>de.uniwue</groupId>
@@ -16,6 +17,8 @@
         <java.version>1.8</java.version>
         <spring.version>5.2.22.RELEASE</spring.version>
         <cglib.version>3.2.8</cglib.version>
+        <logback.version>1.5.6</logback.version>
+        <log.sl4j.version>2.1.0-alpha1</log.sl4j.version>
         <junit.jupiter.version>5.6.2</junit.jupiter.version>
     </properties>
 
@@ -59,6 +62,19 @@
             <scope>compile</scope>
         </dependency>
 
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${log.sl4j.version}</version>
+        </dependency>
+
+
         <!-- Java Advanced Imaging (JAI) Image I/O Tools -->
         <dependency>
             <groupId>com.github.jai-imageio</groupId>
@@ -219,4 +235,4 @@
             </plugin>
         </plugins>
     </build>
-</project>
+</project>

src/main/java/de/uniwue/web/config/LarexConfiguration.java

@@ -3,6 +3,8 @@
 import java.io.*;
 import java.util.*;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Component;
 
@@ -15,6 +17,9 @@
 @Scope("session")
 public class LarexConfiguration {
 
+
+	static Logger logger = LoggerFactory.getLogger(LarexConfiguration.class);
+	private String configurationFile;
 	private Map<String, String> configurations;
 
 	/**
@@ -26,6 +31,7 @@ public class LarexConfiguration {
 	public void read(File configuration) {
 		configurations = new HashMap<>();
 		try {
+			this.configurationFile = configuration.getAbsolutePath();
 			FileReader input = new FileReader(configuration);
 			Properties prop = new Properties();
 			prop.load(input);
@@ -49,7 +55,7 @@ public void read(File configuration) {
 	 */
 	public String getSetting(String setting) {
 		if (!isInitiated()) {
-			System.err.println("Configuration file has not been read.");
+			logger.error("Configuration {} has not been read, return empty String", this.configurationFile);
 			return "";
 		}
 		return configurations.getOrDefault(setting, "");
@@ -64,7 +70,7 @@ public String getSetting(String setting) {
 	 */
 	public List<String> getListSetting(String setting) {
 		if (!isInitiated()) {
-			System.err.println("Configuration file has not been read.");
+			logger.error("Configuration {} has not been read, return empty List", this.configurationFile);
 			return new ArrayList<>();
 		}
 		if (configurations.containsKey(setting)) {
@@ -83,7 +89,7 @@ public List<String> getListSetting(String setting) {
 	 */
 	public void setSetting(String setting, String value) {
 		if (!isInitiated()) {
-			System.err.println("Configuration file has not been read.");
+			logger.error("Configuration {} has not been read, set empty Map", this.configurationFile);
 			this.configurations = new HashMap<String, String>();
 		}
 		configurations.put(setting, value);

src/main/java/de/uniwue/web/controller/FileController.java

@@ -26,6 +26,8 @@
 import org.opencv.core.Size;
 import org.opencv.imgcodecs.Imgcodecs;
 import org.opencv.imgproc.Imgproc;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Scope;
 import org.springframework.http.HttpHeaders;
@@ -62,6 +64,9 @@
 @Controller
 @Scope("session")
 public class FileController {
+
+	static Logger logger = LoggerFactory.getLogger(FileController.class);
+
 	@Autowired
 	private ServletContext servletContext;
 	@Autowired
@@ -406,7 +411,8 @@ private File getXMLFilePath(String xmlName, Integer bookid){
 						if(!savedir.endsWith(File.separator)) { savedir += File.separator; }
 						return new File(savedir + xmlName);
 					} else {
-						System.err.println("Warning: Save dir is not set. File could not been saved.");
+						logger.error("Warning: Save dir {} not set. File {} could not been saved.", 
+						savedir, xmlName);
 					}
 				} else {
 					return new File(fileManager.getLocalXmlMap().get(xmlName.split("\\.")[0]));

src/main/java/de/uniwue/web/controller/LibraryController.java

@@ -10,6 +10,9 @@
 import de.uniwue.web.communication.DirectRequest;
 import de.uniwue.web.config.Constants;
 import de.uniwue.web.io.MetsReader;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Controller;
@@ -31,6 +34,11 @@
 @Controller
 @Scope("request")
 public class LibraryController {
+
+	public static final String ENV_LAREX_VERSION = "LAREX_VERSION";
+
+	static Logger logger = LoggerFactory.getLogger(LibraryController.class);
+
 	@Autowired
 	private ServletContext servletContext;
 	@Autowired
@@ -80,15 +88,16 @@ public String home(Model model) throws IOException {
 		}
 		File bookPath = new File(fileManager.getLocalBooksPath());
 		if (!bookPath.isDirectory()) {
-			System.err.println("ERROR:\tSpecified bookpath is not a directory");
-			System.err.println("\tPlease set a valid bookpath in larex.properties");
+			logger.error("Specified bookpath {} no directory, Please set a valid bookpath in larex.properties!",
+			bookPath);
 			return "redirect:/500";
 		}
 		FileDatabase database = new FileDatabase(bookPath, config.getListSetting("imagefilter"), false);
 		Library lib = new Library(database);
 
 		model.addAttribute("library", lib);
 		model.addAttribute("timeStamp", timeStamp);
+		logger.info("Start LAREX using {}", this.fileManager.getConfigurationFile());
 		return "lib";
 	}
 
@@ -120,7 +129,7 @@ public String home(Model model) throws IOException {
 				case "flat":
 					return getFileMap(baseFolder.getAbsolutePath(), Constants.IMG_EXTENSIONS_DOTTED);
 				default:
-					System.out.println("Attempting to open empty directory");
+					logger.error("Attempt open empty directory {}", baseFolder.getAbsolutePath());
 					break;
 			}
 		} catch (Exception e) {
@@ -162,8 +171,13 @@ public String home(Model model) throws IOException {
 	 */
 	@RequestMapping(value = "library/getOldRequest", method = RequestMethod.POST, headers = "Accept=*/*")
 	public @ResponseBody DirectRequest getOldRequest() {
-		return fileManager.getDirectRequest();
+		DirectRequest directRequest = this.fileManager.getDirectRequest();
+		if (directRequest != null) {
+			logger.info("pass last {}", directRequest.getMetsPath());
+		}
+		return directRequest;
 	}
+
 	/**
 	 * returns each imagePath in given directory
 	 * respecting the SubExtensionFilter set in properties
@@ -219,7 +233,11 @@ public Map<String, List<String>> getFileMap(String baseFolder, List<String> extL
 	@RequestMapping(value ="library/getVersion" , method = RequestMethod.GET)
 	public @ResponseBody
 	String getVersion() {
-		String larex_version = System.getenv("LAREX_VERSION");
-		return larex_version.equals("") ? "UNKNOWN" : larex_version;
+		String larexVersion = System.getenv(ENV_LAREX_VERSION);
+		if (larexVersion == null) {
+			logger.warn("LAREX_VERSION unset in Env");
+			larexVersion = "";
+		}
+		return "".equals(larexVersion) ? "UNKNOWN" : larexVersion;
 	}
 }

src/main/java/de/uniwue/web/controller/ViewerController.java

@@ -13,6 +13,9 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import de.uniwue.web.communication.DirectRequest;
 import de.uniwue.web.io.MetsReader;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Controller;
@@ -35,6 +38,9 @@
 @Controller
 @Scope("request")
 public class ViewerController {
+
+	static Logger logger = LoggerFactory.getLogger(ViewerController.class);
+
 	@Autowired
 	private ServletContext servletContext;
 	@Autowired
@@ -99,8 +105,7 @@ public String direct(Model model,
 			}
 			mimeMap = mapper.readValue(java.net.URLDecoder.decode(mimeMapString, StandardCharsets.UTF_8.name()), TreeMap.class);
 		} catch (IOException e) {
-			System.out.println(e.getMessage());
-			e.printStackTrace();
+			logger.error("Internal Exception {}", e.getMessage());
 			return "redirect:/error/500";
 		}
 		if(customFlag.equals("true") && !customFolder.endsWith(File.separator)) { customFolder += File.separator; }

src/main/java/de/uniwue/web/facade/segmentation/LarexFacade.java

@@ -13,6 +13,8 @@
 import de.uniwue.web.model.*;
 import org.opencv.core.Mat;
 import org.opencv.core.Size;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.w3c.dom.Document;
 import org.xml.sax.SAXException;
 
@@ -32,6 +34,8 @@
  */
 public class LarexFacade {
 
+	static Logger logger = LoggerFactory.getLogger(LarexFacade.class);
+
 	/**
 	 * Segment a page with the LAREX segmentation algorithm
 	 *
@@ -82,11 +86,9 @@ public static PageAnnotations segmentPage(SegmentationSettings settings, int pag
 			MemoryCleaner.clean(original);
 			segmentationResult = result;
 		} else {
-			System.err.println(
-					"Warning: Image file could not be found. Segmentation result will be empty. File: " + imagePath);
+			logger.warn("Image file {} could not be found. Segmentation will be empty!", imagePath);
 		}
 		// TODO fix metadata insertion here instead of frontend (?)
-
 		page.setOrientation(orientation);
 		if (segmentationResult != null) {
 			segmentation = new PageAnnotations(page.getName(), page.getXmlName(), page.getWidth(), page.getHeight(),