feat: Changing logging approach - to use different frameworks for FX and CLI modes.

Author: exadmin

src/main/java/com/github/exadmin/cyberferret/CyberFerretCLI.java

@@ -1,5 +1,6 @@
 package com.github.exadmin.cyberferret;
 
+import com.github.exadmin.cyberferret.cli.RunnableCheckOnlineDictionaryProxy;
 import com.github.exadmin.cyberferret.utils.ConsoleUtils;
 import com.github.exadmin.cyberferret.utils.FileUtils;
 
@@ -26,12 +27,12 @@ private static void terminateAppWithErrorCode() {
 
     public static void main(String[] args) {
         // Overall logic
-        // step1: Check required program arguments are set
-        // step2: Check required system env variables are set
-        // step2: Ensure actual dictionary is downloaded
-        // step3: Download dictionary if required
-        // step4: Decrypt dictionary
-        // step5: Run check over the git-repository
+        // Step1: Check required program arguments are set
+        // Step2: Check required system env variables are set
+        // Step3: Ensure actual dictionary is downloaded
+        // Step4: Download dictionary if required
+        // Step5: Decrypt dictionary
+        // Step6: Run check over the git-repository
 
 
         // Step1: Check required program arguments are set
@@ -48,14 +49,18 @@ public static void main(String[] args) {
             terminateAppWithErrorCode();
         }
 
-        // step2: Check required system env variables are set
+        // Step2: Check required system env variables are set
         final String pass = System.getenv(SYS_ENV_VAR_PASSWORD);
         if (pass == null || pass.isEmpty()) {
             ConsoleUtils.error("Missing environment variable {}", SYS_ENV_VAR_PASSWORD);
             printUsage();
             terminateAppWithErrorCode();
         }
 
+        // Step3: Ensure actual dictionary is downloaded
+        Runnable dictionaryDownloader = new RunnableCheckOnlineDictionaryProxy();
+        dictionaryDownloader.run();
+
         ConsoleUtils.debug("Scan is fakely completed");
     }
 }

src/main/java/com/github/exadmin/cyberferret/async/ARunnable.java

@@ -2,7 +2,7 @@
 
 import org.slf4j.Logger;
 
-public abstract class ARunnable implements Runnable {
+public abstract class ARunnable implements Runnable, Loggable {
     protected Runnable beforeStart;
     protected Runnable afterFinished;
 
@@ -15,7 +15,7 @@ public void setAfterFinished(Runnable afterFinished) {
     }
 
     protected abstract void _run() throws Exception;
-    protected abstract Logger getLog();
+
 
     @Override
     public final void run()  {
@@ -33,4 +33,29 @@ public final void startNowInNewThread() {
         thread.setDaemon(true);
         thread.start();
     }
+
+    @Override
+    public void logError(String msg, Object... binds) {
+        if (getLog() != null) getLog().error(msg, binds);
+    }
+
+    @Override
+    public void logWarn(String msg, Object... binds) {
+        if (getLog() != null) getLog().warn(msg, binds);
+    }
+
+    @Override
+    public void logInfo(String msg, Object... binds) {
+        if (getLog() != null) getLog().info(msg, binds);
+    }
+
+    @Override
+    public void logDebug(String msg, Object... binds) {
+        if (getLog() != null) getLog().debug(msg, binds);
+    }
+
+    @Override
+    public void logTrace(String msg, Object... binds) {
+        if (getLog() != null) getLog().trace(msg, binds);
+    }
 }

src/main/java/com/github/exadmin/cyberferret/async/Loggable.java

@@ -0,0 +1,12 @@
+package com.github.exadmin.cyberferret.async;
+
+import org.slf4j.Logger;
+
+public interface Loggable {
+    Logger getLog();
+    void logError(String msg, Object ... binds);
+    void logWarn(String msg, Object ... binds);
+    void logInfo(String msg, Object ... binds);
+    void logDebug(String msg, Object ... binds);
+    void logTrace(String msg, Object ... binds);
+}

src/main/java/com/github/exadmin/cyberferret/async/RunnableCheckOnlineDictionary.java

@@ -14,20 +14,20 @@
 import java.io.InputStream;
 
 public class RunnableCheckOnlineDictionary extends ARunnable {
-    private static final Logger log = LoggerFactory.getLogger(RunnableCheckOnlineDictionary.class);
+    private volatile static Logger log = null;
 
     @Override
     protected void _run() throws Exception {
-        log.info("Checking if new online dictionary exists");
+        logInfo("Checking if new online dictionary exists");
 
         File savePath = new File(FxConstants.DICTIONARY_FILE_PATH_ENCRYPTED);
 
         if (savePath.exists()) {
             boolean wasDeleted = savePath.delete();
-            if (wasDeleted) log.info("Previous version of downloaded copy was cleaned by path {}", savePath);
+            if (wasDeleted) logInfo("Previous version of downloaded copy was cleaned by path {}", savePath);
         }
 
-        log.info("Downloading latest online dictionary");
+        logInfo("Downloading latest online dictionary");
         try (CloseableHttpClient client = HttpClients.createDefault()) {
             HttpGet request = new HttpGet(FxConstants.CYBER_FERRET_ONLINE_DICTIONARY_URL);
             try (CloseableHttpResponse response = client.execute(request);
@@ -38,15 +38,18 @@ protected void _run() throws Exception {
                 while ((byteRead = inputStream.read()) != -1) {
                     writer.write(byteRead);
                 }
-                log.info("File was downloaded successfully and saved in {}", savePath.getAbsoluteFile());
+                logInfo("File was downloaded successfully and saved in {}", savePath.getAbsoluteFile());
             }
         } catch (IOException ex) {
-            log.error("Error while downloading online dictionary file", ex);
+            logError("Error while downloading online dictionary file", ex);
         }
     }
 
     @Override
-    protected Logger getLog() {
-        return null;
+    public Logger getLog() {
+        if (log == null) {
+            log = LoggerFactory.getLogger(RunnableCheckOnlineDictionary.class);
+        }
+        return log;
     }
 }

src/main/java/com/github/exadmin/cyberferret/async/RunnableScanner.java

@@ -66,7 +66,7 @@ public void setFxCallback(FxCallback fxCallback) {
     }
 
     @Override
-    protected Logger getLog() {
+    public Logger getLog() {
         return log;
     }
 

src/main/java/com/github/exadmin/cyberferret/async/RunnableSigsLoader.java

@@ -52,7 +52,7 @@ public boolean isReady() {
     }
 
     @Override
-    protected Logger getLog() {
+    public Logger getLog() {
         return log;
     }
 

src/main/java/com/github/exadmin/cyberferret/cli/RunnableCheckOnlineDictionaryProxy.java

@@ -0,0 +1,31 @@
+package com.github.exadmin.cyberferret.cli;
+
+import com.github.exadmin.cyberferret.async.RunnableCheckOnlineDictionary;
+import com.github.exadmin.cyberferret.utils.ConsoleUtils;
+
+public class RunnableCheckOnlineDictionaryProxy extends RunnableCheckOnlineDictionary {
+    @Override
+    public void logError(String msg, Object... binds) {
+        ConsoleUtils.error(msg, binds);
+    }
+
+    @Override
+    public void logWarn(String msg, Object... binds) {
+        throw new IllegalStateException("Not implemented yet");
+    }
+
+    @Override
+    public void logInfo(String msg, Object... binds) {
+        ConsoleUtils.info(msg, binds);
+    }
+
+    @Override
+    public void logDebug(String msg, Object... binds) {
+        ConsoleUtils.debug(msg, binds);
+    }
+
+    @Override
+    public void logTrace(String msg, Object... binds) {
+        throw new IllegalStateException("Not implemented yet");
+    }
+}

src/main/java/com/github/exadmin/cyberferret/utils/ConsoleUtils.java

@@ -2,6 +2,11 @@
 
 public class ConsoleUtils {
 
+    public static void info(String msg, Object ... binds) {
+        String result = "[INFO ] " + format(msg, binds);
+        System.out.println(result);
+    }
+
     public static void debug(String msg, Object ... binds) {
         String result = "[DEBUG] " + format(msg, binds);
         System.out.println(result);