Update log4j

Logs to `%USERPROFILE%\.listDir()\logs`
Borewit · Jan 30, 2023 · 4be063d · 4be063d
1 parent c6380fe
commit 4be063d
Show file tree

Hide file tree

Showing 38 changed files with 425 additions and 923 deletions.
diff --git a/build.gradle b/build.gradle
@@ -112,8 +112,19 @@ dependencies {
     // https://mvnrepository.com/artifact/javax.xml.bind/jaxb-api
     implementation 'javax.xml.bind:jaxb-api:2.3.1'
 
-    // https://mvnrepository.com/artifact/log4j/log4j
-    implementation 'log4j:log4j:1.2.6'
+    // https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core
+    implementation 'org.apache.logging.log4j:log4j-core:2.19.0'
+
+    // Apache SLF4J to Log4j2 Adapter (bridge)
+    // https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-slf4j-impl
+    runtimeOnly 'org.apache.logging.log4j:log4j-slf4j-impl:2.19.0'
+
+    // Required for log4j yaml configuration files
+    // https://mvnrepository.com/artifact/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml
+    implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.14.2'
+
+    // https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.14.2'
 
     // https://mvnrepository.com/artifact/commons-io/commons-io
     implementation 'commons-io:commons-io:2.11.0'
@@ -122,9 +133,6 @@ dependencies {
     // https://mvnrepository.com/artifact/com.jcabi/jcabi-manifests/1.2.1
     implementation 'com.jcabi:jcabi-manifests:1.2.1'
 
-    // https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core
-    implementation 'com.fasterxml.jackson.core:jackson-databind:2.14.1'
-
     // Required by "src/jar/lizzy.jar"
     // https://mvnrepository.com/artifact/commons-logging/commons-logging
     runtimeOnly 'commons-logging:commons-logging:1.2'
@@ -185,7 +193,7 @@ task makePngIcon(type: Svg2PngTask) {
     destination = new File("$generatedImages/icon.png")
 }
 
-processResources.dependsOn makePngIcon
+tasks.processResources.dependsOn makePngIcon
 
 task generateSplashScreenWithVersion(type: Copy) {
     group = 'graphics'
@@ -202,7 +210,7 @@ task makeSplashScreen(type: Svg2PngTask, dependsOn: generateSplashScreenWithVers
     destination = new File("$generatedImages/listfixSplashScreen.png")
 }
 
-processResources.dependsOn makeSplashScreen
+tasks.processResources.dependsOn makeSplashScreen
 
 task makeIcon (type: Svg2IcoTask) {
     group = 'graphics'

diff --git a/src/commons-logging.properties → commons-logging.properties b/src/commons-logging.properties → commons-logging.properties
diff --git a/src/simplelog.properties → simplelog.properties b/src/simplelog.properties → simplelog.properties
diff --git a/src/log4j.properties b/src/log4j.properties
diff --git a/src/log4j_dev.properties b/src/log4j_dev.properties
diff --git a/src/main/java/listfix/config/JsonConfigFile.java b/src/main/java/listfix/config/JsonConfigFile.java
@@ -3,7 +3,8 @@
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import java.io.File;
 import java.io.IOException;
@@ -12,7 +13,7 @@
 
 public abstract class JsonConfigFile<T>
 {
-  public static final Logger _logger = Logger.getLogger(JsonConfigFile.class);
+  public static final Logger _logger = LogManager.getLogger(JsonConfigFile.class);
 
   protected final File jsonFile;
   protected T jsonPojo = null;

diff --git a/src/main/java/listfix/controller/GUIDriver.java b/src/main/java/listfix/controller/GUIDriver.java
@@ -20,19 +20,17 @@
 
 package listfix.controller;
 
-import java.io.File;
-import java.io.IOException;
-
 import listfix.config.ApplicationOptionsConfiguration;
 import listfix.config.IAppOptions;
 import listfix.config.IMediaLibrary;
 import listfix.config.MediaLibraryConfiguration;
 import listfix.json.JsonAppOptions;
 import listfix.model.PlaylistHistory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
-import listfix.util.ExStack;
-
-import org.apache.log4j.Logger;
+import java.io.File;
+import java.io.IOException;
 
 /**
  * @author jcaron
@@ -49,7 +47,7 @@ public final class GUIDriver
    */
   public static final boolean FILE_SYSTEM_IS_CASE_SENSITIVE = File.separatorChar == '/';
 
-  private static final Logger _logger = Logger.getLogger(GUIDriver.class);
+  private static final Logger _logger = LogManager.getLogger(GUIDriver.class);
   private static GUIDriver _instance;
 
   /**
@@ -80,7 +78,7 @@ private GUIDriver()
       showMediaDirWindow = true;
 
       // This happens by design the first time the app is executed, so to minimize confusion, we disable console logging when we distribute listFix()
-      _logger.error(ExStack.toString(e));
+      _logger.error("Error initializing", e);
     }
   }
 

diff --git a/src/main/java/listfix/controller/MediaLibraryOperator.java b/src/main/java/listfix/controller/MediaLibraryOperator.java
@@ -21,10 +21,10 @@
 package listfix.controller;
 
 import listfix.config.MediaLibraryConfiguration;
-import listfix.io.*;
-import listfix.util.*;
+import listfix.io.DirectoryScanner;
 import listfix.view.support.ProgressWorker;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import java.io.IOException;
 import java.util.Collection;
@@ -35,7 +35,7 @@
  */
 public class MediaLibraryOperator
 {
-  private static final Logger _logger = Logger.getLogger(MediaLibraryOperator.class);
+  private static final Logger _logger = LogManager.getLogger(MediaLibraryOperator.class);
   private MediaLibraryConfiguration mediaLibraryConfiguration;
   private ProgressWorker _observer;
 
@@ -69,7 +69,7 @@ public void addDirectory(String dir)
       }
       catch (IOException e)
       {
-        _logger.error(ExStack.toString(e));
+        _logger.error("Error", e);
       }
     }
   }
@@ -96,7 +96,7 @@ public void refresh()
       }
       catch (IOException e)
       {
-        _logger.error(ExStack.toString(e));
+        _logger.error("Error", e);
       }
     }
   }

diff --git a/src/main/java/listfix/controller/tasks/WriteMediaLibraryIniTask.java b/src/main/java/listfix/controller/tasks/WriteMediaLibraryIniTask.java
@@ -24,14 +24,15 @@
 
 import listfix.config.MediaLibraryConfiguration;
 
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * @author jcaron
  */
 public class WriteMediaLibraryIniTask extends listfix.controller.Task
 {
-  private static final Logger _logger = Logger.getLogger(WriteMediaLibraryIniTask.class);
+  private static final Logger _logger = LogManager.getLogger(WriteMediaLibraryIniTask.class);
 
   private final MediaLibraryConfiguration mediaLibraryConfiguration;
 
@@ -52,7 +53,7 @@ public void run()
     }
     catch (IOException e)
     {
-      _logger.error(e);
+      _logger.error("Error writing configuration to " + this.mediaLibraryConfiguration.getFile().getName(), e);
     }
   }
 }
diff --git a/src/main/java/listfix/io/BrowserLauncher.java b/src/main/java/listfix/io/BrowserLauncher.java
@@ -20,14 +20,13 @@
 
 package listfix.io;
 
-import java.lang.reflect.Method;
-import javax.swing.JOptionPane;
-
-import listfix.util.ExStack;
 import listfix.util.OperatingSystem;
 import listfix.view.controls.JTransparentTextArea;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
-import org.apache.log4j.Logger;
+import javax.swing.*;
+import java.lang.reflect.Method;
 
 /**
  * A class who's sole responsibility is to launch the default web browser on various OSes.
@@ -36,7 +35,7 @@
 public class BrowserLauncher
 {
   private static final String _errMsg = "Error attempting to launch default web browser";
-  private static final Logger _logger = Logger.getLogger(BrowserLauncher.class);
+  private static final Logger _logger = LogManager.getLogger(BrowserLauncher.class);
 
   /**
    * Attempts to open the given url in the system's default web browser.
@@ -85,7 +84,7 @@ else if (OperatingSystem.isWindows())
     catch (Exception e)
     {
       JOptionPane.showMessageDialog(null, new JTransparentTextArea(_errMsg + ": " + e.getLocalizedMessage()));
-      _logger.info(ExStack.toString(e));
+      _logger.warn(e);
     }
   }
 }
diff --git a/src/main/java/listfix/io/WinampHelper.java b/src/main/java/listfix/io/WinampHelper.java
@@ -1,5 +1,4 @@
-
-/**
+/*
  * listFix() - Fix Broken Playlists!
  * <p>
  * This file is part of listFix().
@@ -19,26 +18,26 @@
  */
 package listfix.io;
 
-import java.io.File;
-import java.io.IOException;
-import java.util.List;
-
-import javax.xml.bind.JAXBContext;
-import javax.xml.bind.JAXBException;
-import javax.xml.bind.Unmarshaller;
-
 import listfix.config.IMediaLibrary;
-import listfix.io.writers.FileCopier;
 import listfix.model.BatchRepair;
 import listfix.model.BatchRepairItem;
 import listfix.model.playlists.winamp.generated.Playlist;
 import listfix.model.playlists.winamp.generated.Playlists;
-import listfix.util.ExStack;
 import listfix.util.OperatingSystem;
 import listfix.view.support.IProgressObserver;
 import listfix.view.support.ProgressAdapter;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
-import org.apache.log4j.Logger;
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Unmarshaller;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
+import java.util.List;
 
 /**
  * Provides convenience methods for interacting w/ the Winamp Media Library and determining if Winamp is installed.
@@ -50,7 +49,7 @@ public class WinampHelper
   private static final String HOME_PATH = System.getenv("APPDATA");
   private static final String WINAMP_PATH1 = HOME_PATH + "\\Winamp\\Plugins\\ml\\playlists\\";
   private static final String WINAMP_PATH2 = HOME_PATH + "\\Winamp\\Plugins\\ml\\";
-  private static final Logger _logger = Logger.getLogger(WinampHelper.class);
+  private static final Logger _logger = LogManager.getLogger(WinampHelper.class);
 
   private static String WINAMP_PATH = "";
 
@@ -93,17 +92,11 @@ public static BatchRepair getWinampBatchRepair(IMediaLibrary mediaFiles, IPlayLi
     }
     catch (JAXBException ex)
     {
-      _logger.error(ExStack.toString(ex));
+      _logger.error("Error while repairing Winamp playlist", ex);
       return null;
     }
   }
 
-  /**
-   * @param destDir
-   * @param observer
-   * @throws JAXBException
-   * @throws IOException
-   */
   public static void extractPlaylists(File destDir, IProgressObserver observer) throws JAXBException, IOException
   {
     // avoid resetting total if part of batch operation
@@ -122,8 +115,10 @@ public static void extractPlaylists(File destDir, IProgressObserver observer) th
     }
     for (Playlist list : winLists)
     {
-      FileCopier.copy(new File(WINAMP_PATH + list.getFilename()),
-          new File(destDir.getPath() + System.getProperty("file.separator") + FileUtils.replaceInvalidWindowsFileSystemCharsWithChar(list.getTitle(), '_') + ".m3u8"));
+      Path sourceFile = Path.of(WINAMP_PATH, list.getFilename());
+      Path targetPath = Path.of(destDir.getPath(), FileUtils.replaceInvalidWindowsFileSystemCharsWithChar(list.getTitle(), '_') + ".m3u8");
+      Files.copy(sourceFile, targetPath, StandardCopyOption.REPLACE_EXISTING);
+
       progress.stepCompleted();
     }
   }

diff --git a/src/main/java/listfix/io/readers/playlists/ITunesXMLReader.java b/src/main/java/listfix/io/readers/playlists/ITunesXMLReader.java
@@ -40,7 +40,8 @@
 import listfix.util.UnicodeUtils;
 import listfix.view.support.IProgressObserver;
 
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  *
@@ -49,7 +50,7 @@
 public class ITunesXMLReader extends PlaylistReader
 {
   private String _encoding;
-  private static final Logger _logger = Logger.getLogger(ITunesXMLReader.class);
+  private static final Logger _logger = LogManager.getLogger(ITunesXMLReader.class);
 
   private ITunesMediaLibrary _library;