Support for multiple playlist folders (#93)

- Add support for multiple playlist folders
- Removed are you sure dialog before showing renaming dialog
- Keep playlist-editor-tabs in sync with playlists-directories
- Disabling renaming multiple files
- Disabling renaming playlists
- Fixing issues with tab headers of playlist-editors

Author: Borewit

src/main/java/listfix/io/TreeNodeFile.java renamed to src/main/java/listfix/comparators/DirectoryThenFileThenAlphabeticalPathComparator.java

@@ -18,30 +18,32 @@
  * along with this program; if not, please see http://www.gnu.org/licenses/
  */
 
-package listfix.io;
+package listfix.comparators;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
 
 /**
- *
- * @author jcaron
+ * Sorts directories ahead of files, and then sorts files alphabetically (ignoring case).
  */
-public class TreeNodeFile extends java.io.File
+public class DirectoryThenFileThenAlphabeticalPathComparator implements java.util.Comparator<Path>
 {
-  /**
-   *
-   * @param filename
-   */
-  public TreeNodeFile(String filename)
-  {
-    super(filename);
-  }
 
-  /**
-   *
-   * @return
-   */
   @Override
-  public String toString()
+  public int compare(Path a, Path b)
   {
-    return this.getName();
+    if (!Files.isDirectory(a) && Files.isDirectory(b))
+    {
+      return 1;
+    }
+    else if (Files.isDirectory(a) && !Files.isDirectory(b))
+    {
+      return -1;
+    }
+    else
+    {
+      // both Files are files or both are directories
+      return a.compareTo(b);
+    }
   }
 }

src/main/java/listfix/config/IAppOptions.java

@@ -17,7 +17,7 @@ public interface IAppOptions extends IPlaylistOptions
   String getPlaylistsDirectory();
 
   /**
-   * @return the appFont
+   * @return configured application font
    */
   Font getAppFont();
 }

src/main/java/listfix/config/IMediaLibrary.java

@@ -4,9 +4,19 @@
 
 public interface IMediaLibrary
 {
-  Set<String> getDirectories();
+  /**
+   * User configured top level media directories.
+   * Used to search media files in
+   */
+  Set<String> getMediaDirectories();
 
+  /**
+   * Cached nested directories, derived from media-directories
+   */
   Set<String> getNestedDirectories();
 
+  /**
+   * Cached nested files, derived from media-directories
+   */
   Set<String> getNestedMediaFiles();
 }

src/main/java/listfix/config/JsonConfigFile.java

@@ -13,7 +13,7 @@
 
 public abstract class JsonConfigFile<T>
 {
-  public static final Logger _logger = LogManager.getLogger(JsonConfigFile.class);
+  public final Logger logger = LogManager.getLogger(JsonConfigFile.class);
 
   protected final File jsonFile;
   protected T jsonPojo = null;

src/main/java/listfix/config/MediaLibraryConfiguration.java

@@ -46,14 +46,9 @@ private void clearMediaLibraryDirectoryList()
     this.jsonPojo.getNestedDirectories().clear();
   }
 
-  /**
-   * @param dir
-   * @return
-   * @throws MediaDirNotFoundException
-   */
   public void removeMediaDir(String dir) throws MediaDirNotFoundException
   {
-    final Set<String> mediaDir = this.jsonPojo.getDirectories();
+    final Set<String> mediaDir = this.jsonPojo.getMediaDirectories();
     final boolean found = mediaDir.remove(dir);
 
     if (found)
@@ -80,7 +75,7 @@ public void removeMediaDir(String dir) throws MediaDirNotFoundException
 
   public void cleanNonExistingMediaDirectories() throws MediaDirNotFoundException
   {
-    for (String dir : new ArrayList<>(this.jsonPojo.getDirectories()))
+    for (String dir : new ArrayList<>(this.jsonPojo.getMediaDirectories()))
     {
       if (!new File(dir).exists())
       {
@@ -116,6 +111,7 @@ public void switchMediaLibraryToUNCPaths()
    */
   public void writeOnBackground()
   {
+    this.logger.info("Writing media-library-configuration in background");
     WriteMediaLibraryIniTask thisTask = new WriteMediaLibraryIniTask(this);
     thisTask.start();
   }

src/main/java/listfix/controller/ListFixController.java

@@ -41,6 +41,13 @@ private ListFixController()
       this.mediaLibraryConfiguration = MediaLibraryConfiguration.load();
       this.applicationOptionsConfiguration = ApplicationOptionsConfiguration.load();
 
+      String oldPlaylistDirectory = this.applicationOptionsConfiguration.getConfig().getPlaylistsDirectory();
+      if (this.applicationOptionsConfiguration.getConfig().getPlaylistDirectories().isEmpty() && oldPlaylistDirectory != null && !oldPlaylistDirectory.isEmpty()) {
+        _logger.error(String.format("Migrating playlists directory: %s", oldPlaylistDirectory));
+        this.applicationOptionsConfiguration.getConfig().getPlaylistDirectories().add(oldPlaylistDirectory);
+        this.mediaLibraryConfiguration.writeOnBackground();
+      }
+
       this.history = new PlaylistHistory(this.applicationOptionsConfiguration.getConfig().getMaxPlaylistHistoryEntries());
       this.history.load();
 

src/main/java/listfix/controller/MediaLibraryOperator.java

@@ -47,7 +47,7 @@ public MediaLibraryOperator(ProgressWorker observer)
 
   public void addDirectory(String dir)
   {
-    final Set<String> mediaDir = this.mediaLibraryConfiguration.getConfig().getDirectories();
+    final Set<String> mediaDir = this.mediaLibraryConfiguration.getConfig().getMediaDirectories();
     mediaDir.add(dir);
     DirectoryScanner ds = new DirectoryScanner();
     ds.createMediaLibraryDirectoryAndFileList(mediaDir, _observer);
@@ -79,7 +79,7 @@ private static void replaceSetValues(Set<String> set, Collection<String> newValu
   public void refresh()
   {
     DirectoryScanner ds = new DirectoryScanner();
-    ds.createMediaLibraryDirectoryAndFileList(this.mediaLibraryConfiguration.getConfig().getDirectories(), _observer);
+    ds.createMediaLibraryDirectoryAndFileList(this.mediaLibraryConfiguration.getConfig().getMediaDirectories(), _observer);
     if (!_observer.getCancelled())
     {
       _observer.setMessage("Finishing...");

src/main/java/listfix/io/Constants.java

@@ -1,23 +1,3 @@
-/*
- *  listFix() - Fix Broken Playlists!
- *  Copyright (C) 2001-2014 Jeremy Caron
- *
- *  This file is part of listFix().
- *
- *  This program is free software; you can redistribute it and/or
- *  modify it under the terms of the GNU General Public License
- *  as published by the Free Software Foundation; either version 2
- *  of the License, or (at your option) any later version.
- *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, please see http://www.gnu.org/licenses/
- */
-
 package listfix.io;
 
 import java.io.File;
@@ -60,4 +40,5 @@ public class Constants
    * Boolean specifying if the current OS's file system is case-sensitive.
    */
   public static final boolean FILE_SYSTEM_IS_CASE_SENSITIVE = File.separatorChar == '/';
+
 }

src/main/java/listfix/io/FileTreeNodeGenerator.java

@@ -1,114 +1,65 @@
-/*
- * listFix() - Fix Broken Playlists!
- * Copyright (C) 2001-2014 Jeremy Caron
- *
- * This file is part of listFix().
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, please see http://www.gnu.org/licenses/
- */
-
 package listfix.io;
 
-import listfix.comparators.DirectoryThenFileThenAlphabeticalFileComparator;
-import listfix.io.filters.PlaylistFileFilter;
+import listfix.comparators.DirectoryThenFileThenAlphabeticalPathComparator;
+import listfix.model.playlists.Playlist;
 import listfix.view.support.PlaylistTreeNode;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import javax.swing.tree.TreePath;
-import java.io.File;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import java.util.Collection;
+import java.util.stream.Stream;
+
 
-/**
- *
- * @author jcaron
- */
 public class FileTreeNodeGenerator
 {
-  /** Add nodes from under "dir" into curTop. Highly recursive.
-   * @param curTop
-   * @param dir
-   * @return
-   */
-  public static PlaylistTreeNode addNodes(PlaylistTreeNode curTop, File dir)
-  {
-    if (dir.exists())
-    {
-      String curPath = dir.getPath();
-      TreeNodeFile file = new TreeNodeFile(curPath);
-      PlaylistTreeNode curDir = new PlaylistTreeNode(file);
-      // curDir.setUserObject(file);
-
-      // if we're creating the root node here, use a regular file to get the full path to show.
-      if (curTop == null)
-      {
-        curDir.setUserObject(new File(curPath));
-      }
+  private static final Logger logger = LogManager.getLogger(FileTreeNodeGenerator.class);
 
-      List<File> ol = new ArrayList<>();
-      File[] inodes = dir.listFiles(new PlaylistFileFilter());
+  public static PlaylistTreeNode addNodes(PlaylistTreeNode curTop, Collection<Path> playlistDirectories)
+  {
+    return FileTreeNodeGenerator.addNodes(curTop, playlistDirectories.stream());
+  }
 
-      if (inodes != null && inodes.length > 0)
-      {
-                ol.addAll(Arrays.asList(inodes));
-        Collections.sort(ol, new DirectoryThenFileThenAlphabeticalFileComparator());
-        File f;
-        List<File> files = new ArrayList<>();
-        // Make two passes, one for Dirs and one for Files. This is #1.
-        for (File ol1 : ol)
+  /**
+   * Add nodes from under "playlistDirectories" into curTop. Highly recursive.
+   *
+   * @param curTop Tree node, to which the provided files will be added as children. Maybe Null.
+   * @param files  Playlist directories or playlist files to add
+   * @return Playlist tree
+   */
+  public static PlaylistTreeNode addNodes(PlaylistTreeNode curTop, Stream<Path> files)
+  {
+    PlaylistTreeNode currentNode = curTop == null ? new PlaylistTreeNode(Path.of("#___root___")) : curTop;
+    files
+      .filter(file -> Files.isDirectory(file) || Playlist.isPlaylist(file))
+      .sorted(new DirectoryThenFileThenAlphabeticalPathComparator())
+      .map(PlaylistTreeNode :: new)
+      .forEach(node -> {
+        Path path = node.getUserObject();
+        if (Files.isDirectory(path))
         {
-          f = ol1;
-          if (f.isDirectory())
+          try
           {
-            File[] tmp = f.listFiles(new PlaylistFileFilter());
-            if (tmp != null && tmp.length > 0)
-            {
-              addNodes(curDir, f);
-            }
+            addNodes(node, Files.list(path)); // recursion
           }
-          else
+          catch (IOException e)
           {
-            files.add(f);
+            logger.error(String.format("Failed to list files in directory: %s", path), e);
+            throw new RuntimeException(e);
           }
         }
-        // Pass two: for files.
-        for (File file1 : files)
-        {
-          curDir.add(new PlaylistTreeNode(new TreeNodeFile(file1.getPath())));
-        }
-        if (curDir.children().hasMoreElements() || !((File) curDir.getUserObject()).isDirectory())
-        {
-          if (curTop != null)
-          {
-            curTop.add(curDir);
-          }
-        }
-        return curDir;
-      }
-      return null;
-    }
-    return null;
+        currentNode.add(node);
+      });
+    return currentNode;
   }
 
-  /**
-   *
-   * @param node
-   * @return
-   */
-  public static String TreePathToFileSystemPath(TreePath node)
+
+  public static Path TreePathToFileSystemPath(TreePath node)
   {
-    return ((File) ((PlaylistTreeNode) node.getLastPathComponent()).getUserObject()).getPath();
+    return ((PlaylistTreeNode) node.getLastPathComponent()).getUserObject();
   }
 }