Switch encoding from UTF-8 to ISO-8859-1 for .m3u playlists

Borewit · Borewit · commit 47ec0fdd363b · 2023-10-22T15:07:03.000+02:00
diff --git a/build.gradle b/build.gradle
@@ -85,7 +85,7 @@ sourceSets {
 
 
 group = 'io.github.borewit'
-version = '3.0.0'
+version = '3.0.1-SNAPSHOT'
 description = 'Lizzy'
 java.sourceCompatibility = JavaVersion.VERSION_1_9
 
diff --git a/gradle.properties b/gradle.properties
@@ -1,3 +1,4 @@
 # Overide this settings in ~/.gradle/gradle.properties
 ossrhUsername = ''
 ossrhPassword = ''
+org.gradle.jvmargs=-Dfile.encoding=UTF-8
diff --git a/samples/m3u/.gitattribute b/samples/m3u/.gitattribute
@@ -1,4 +1,6 @@
-playlist-utf8.m3u		    text working-tree-encoding=UTF-8
-playlist-utf8-bom.m3u		text working-tree-encoding=UTF-8-BOM
-playlist-utf16be-bom.m3u    text working-tree-encoding=UTF-16BE-BOM
-playlist-utf16le-bom.m3u    text working-tree-encoding=UTF-16LE-BOM
+playlist-utf8.m3u		            text working-tree-encoding=UTF-8
+playlist-utf8-bom.m3u		        text working-tree-encoding=UTF-8-BOM
+playlist-utf16be-bom.m3u            text working-tree-encoding=UTF-16BE-BOM
+playlist-utf16le-bom.m3u            text working-tree-encoding=UTF-16LE-BOM
+playlist-special-characters.m3u     text working-tree-encoding=ISO-8859-1
+*.m3u8		                        text working-tree-encoding=UTF-8
diff --git a/samples/m3u/playlist-iso-8859-1.m3u b/samples/m3u/playlist-iso-8859-1.m3u
@@ -0,0 +1,7 @@
+#EXTM3U
+
+#EXTINF:111, Sample artist name - Sample track title
+C:\Music\SampleMusic.mp3
+
+#EXTINF:222, Special characters
+C:\Music\�����A � ���� ���� N �����  ���� �����a � ���� ���� n �����o ����.mp3
diff --git a/samples/m3u/playlist-utf16be-bom.m3u b/samples/m3u/playlist-utf16be-bom.m3u
diff --git a/samples/m3u/playlist-utf16le-bom.m3u b/samples/m3u/playlist-utf16le-bom.m3u
diff --git a/samples/m3u/playlist-utf8-bom.m3u b/samples/m3u/playlist-utf8-bom.m3u
@@ -3,5 +3,5 @@
 #EXTINF:111, Sample artist name - Sample track title
 C:\Music\SampleMusic.mp3
 
-#EXTINF:222,Example Artist name - Example track title
-C:\Music\ExampleMusic.mp3
+#EXTINF:222, Special characters
+C:\Music\ÀÁÂÃäA Ç ÈÉÊË ÌÍÎÏ N ÒÓÔÕö  ÙÚÛü àáâãäa ç èéêë ìíîï n òóôõöo ùúûü.mp3
diff --git a/samples/m3u/playlist-utf8.m3u b/samples/m3u/playlist-utf8.m3u
diff --git a/samples/m3u/playlist-utf8.m3u8 b/samples/m3u/playlist-utf8.m3u8
@@ -0,0 +1,7 @@
+#EXTM3U
+
+#EXTINF:111, Sample artist name - Sample track title
+C:\Music\SampleMusic.mp3
+
+#EXTINF:222, Special characters
+C:\Music\ÀÁÂÃäA Ç ÈÉÊË ÌÍÎÏ N ÒÓÔÕö  ÙÚÛü àáâãäa ç èéêë ìíîï n òóôõöo ùúûü.mp3
diff --git a/samples/playlists.json b/samples/playlists.json
@@ -108,7 +108,7 @@
       "source" : "C:\\Music\\SampleMusic.mp3"
     }, {
       "repeatCount" : 1.0,
-      "source" : "C:\\Music\\ExampleMusic.mp3"
+      "source" : "C:\\Music\\ÀÁÂÃäA Ç ÈÉÊË ÌÍÎÏ N ÒÓÔÕö  ÙÚÛü àáâãäa ç èéêë ìíîï n òóôõöo ùúûü.mp3"
     } ]
   },
   "m3u/playlist-utf16le-bom.m3u" : {
@@ -117,7 +117,7 @@
       "source" : "C:\\Music\\SampleMusic.mp3"
     }, {
       "repeatCount" : 1.0,
-      "source" : "C:\\Music\\ExampleMusic.mp3"
+      "source" : "C:\\Music\\ÀÁÂÃäA Ç ÈÉÊË ÌÍÎÏ N ÒÓÔÕö  ÙÚÛü àáâãäa ç èéêë ìíîï n òóôõöo ùúûü.mp3"
     } ]
   },
   "m3u/playlist-utf8-bom.m3u" : {
@@ -126,16 +126,16 @@
       "source" : "C:\\Music\\SampleMusic.mp3"
     }, {
       "repeatCount" : 1.0,
-      "source" : "C:\\Music\\ExampleMusic.mp3"
+      "source" : "C:\\Music\\ÀÁÂÃäA Ç ÈÉÊË ÌÍÎÏ N ÒÓÔÕö  ÙÚÛü àáâãäa ç èéêë ìíîï n òóôõöo ùúûü.mp3"
     } ]
   },
-  "m3u/playlist-utf8.m3u" : {
+  "m3u/playlist-iso-8859-1.m3u" : {
     "rootSequence" : [ {
       "repeatCount" : 1.0,
       "source" : "C:\\Music\\SampleMusic.mp3"
     }, {
       "repeatCount" : 1.0,
-      "source" : "C:\\Music\\ExampleMusic.mp3"
+      "source" : "C:\\Music\\ÀÁÂÃäA Ç ÈÉÊË ÌÍÎÏ N ÒÓÔÕö  ÙÚÛü àáâãäa ç èéêë ìíîï n òóôõöo ùúûü.mp3"
     } ]
   },
   "m3u/test01.m3u" : {
diff --git a/src/main/java/io/github/borewit/lizzy/playlist/SpecificPlaylistFactory.java b/src/main/java/io/github/borewit/lizzy/playlist/SpecificPlaylistFactory.java
@@ -117,7 +117,8 @@ public SpecificPlaylist readFrom(Path playlistPath, OpenOption... options) throw
       {
         try
         {
-          SpecificPlaylist specificPlaylist = playlistProvider.readFrom(is, null);
+          final String encoding = playlistPath.toString().toLowerCase().endsWith(".m3u8") ? "UTF-8" : null;
+          SpecificPlaylist specificPlaylist = playlistProvider.readFrom(is, encoding);
           if (specificPlaylist != null)
             return specificPlaylist;
         }
diff --git a/src/main/java/io/github/borewit/lizzy/playlist/m3u/M3U.java b/src/main/java/io/github/borewit/lizzy/playlist/m3u/M3U.java
@@ -57,6 +57,8 @@ public class M3U extends AbstractPlaylist
    */
   private boolean _extensionM3U = false;
 
+  public static final String TextEncoding = "ISO-8859-1";
+
   public void setProvider(final SpecificPlaylistProvider provider)
   {
     _provider = provider;
@@ -75,7 +77,7 @@ public void writeTo(final OutputStream out, final String encoding) throws IOExce
 
     if (enc == null)
     {
-      enc = "UTF-8"; // For the M3U8 case. FIXME US-ASCII?
+      enc = TextEncoding;
     }
 
     final BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(out, enc)); // Throws NullPointerException if out is null. May throw UnsupportedEncodingException.
diff --git a/src/main/java/io/github/borewit/lizzy/playlist/m3u/M3UProvider.java b/src/main/java/io/github/borewit/lizzy/playlist/m3u/M3UProvider.java
@@ -108,7 +108,7 @@ public SpecificPlaylist readFrom(final InputStream inputStream, final String enc
 
     if (enc == null)
     {
-      enc = "UTF-8"; // For the M3U8 case. FIXME US-ASCII?
+      enc = M3U.TextEncoding; // For the M3U8 case. FIXME US-ASCII?
     }
 
 
diff --git a/src/test/java/io/github/borewit/lizzy/playlist/m3u/M3uPlaylistTests.java b/src/test/java/io/github/borewit/lizzy/playlist/m3u/M3uPlaylistTests.java
@@ -15,6 +15,8 @@
 @DisplayName("M3U Playlist Tests")
 public class M3uPlaylistTests
 {
+  public static final String m3uSpecialCharPath = "C:\\Music\\ÀÁÂÃäA Ç ÈÉÊË ÌÍÎÏ N ÒÓÔÕö  ÙÚÛü àáâãäa ç èéêë ìíîï n òóôõöo ùúûü.mp3";
+
   @Test
   @DisplayName("Read M3U playlist file")
   public void readReferenceM3u() throws IOException
@@ -27,6 +29,17 @@ public void readReferenceM3u() throws IOException
     TestUtil.checkPlaylistItemSource(playlist, 2, "http://foofighters.com/somesong.mp3");
   }
 
+  @Test
+  @DisplayName("Read M3U (ISO-8859-1 encoded) playlist with special character")
+  public void readM3uWithSpecialCharacters() throws IOException
+  {
+    Playlist playlist = TestUtil.readPlaylistFrom("m3u/playlist-iso-8859-1.m3u");
+    assertNotNull(playlist, "playlist");
+    assertEquals(2, playlist.getRootSequence().getComponents().size());
+    TestUtil.checkPlaylistItemSource(playlist, 0, "C:\\Music\\SampleMusic.mp3");
+    TestUtil.checkPlaylistItemSource(playlist, 1, m3uSpecialCharPath);
+  }
+
   @Test
   @DisplayName("Read M3U8 playlist with BOM")
   public void readReferenceM3u8WithBom() throws IOException
@@ -37,7 +50,7 @@ public void readReferenceM3u8WithBom() throws IOException
     assertNotNull(playlist, "playlist");
     assertEquals(2, playlist.getRootSequence().getComponents().size());
     TestUtil.checkPlaylistItemSource(playlist, 0, "C:\\Music\\SampleMusic.mp3");
-    TestUtil.checkPlaylistItemSource(playlist, 1, "C:\\Music\\ExampleMusic.mp3");
+    TestUtil.checkPlaylistItemSource(playlist, 1, m3uSpecialCharPath);
   }
 
   @Test
@@ -70,14 +83,14 @@ private static void writeM3u(String testFile) throws IOException
   }
 
   @Test
-  @DisplayName("Read MP3U Playlist UTF-8 no BOM")
+  @DisplayName("Read MP3U8 Playlist UTF-8 no BOM")
   public void readPlaylistM3uUtf8NoBom() throws IOException
   {
-    Playlist m3uPlaylist = TestUtil.readPlaylistFrom("m3u/playlist-utf8.m3u");
+    Playlist m3uPlaylist = TestUtil.readPlaylistFrom("m3u/playlist-utf8.m3u8");
     assertNotNull(m3uPlaylist, "PlaylistFactory should read and construct M3U playlist");
     assertEquals(2, m3uPlaylist.getRootSequence().getComponents().size(), "M3U playlist contains 2 tracks");
     TestUtil.checkPlaylistItemSource(m3uPlaylist, 0, "C:\\Music\\SampleMusic.mp3");
-    TestUtil.checkPlaylistItemSource(m3uPlaylist, 1, "C:\\Music\\ExampleMusic.mp3");
+    TestUtil.checkPlaylistItemSource(m3uPlaylist, 1, m3uSpecialCharPath);
   }
 
   @Test
@@ -88,7 +101,7 @@ public void readPlaylistM3uUtf16BeWithBom() throws IOException
     assertNotNull(m3uPlaylist, "PlaylistFactory should read and construct M3U playlist");
     assertEquals(2, m3uPlaylist.getRootSequence().getComponents().size(), "M3U playlist contains 2 tracks");
     TestUtil.checkPlaylistItemSource(m3uPlaylist, 0, "C:\\Music\\SampleMusic.mp3");
-    TestUtil.checkPlaylistItemSource(m3uPlaylist, 1, "C:\\Music\\ExampleMusic.mp3");
+    TestUtil.checkPlaylistItemSource(m3uPlaylist, 1, m3uSpecialCharPath);
   }
 
   @Test
