Fix escaping of file names for song URIs

WordsLive.Core.Tests/Songs/SongUriTests.cs

@@ -0,0 +1,59 @@
+/*
+ * WordsLive - worship projection software
+ * Copyright (c) 2014 Patrick Reisert
+ * 
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+using System;
+using WordsLive.Core.Songs.Storage;
+using Xunit;
+
+namespace WordsLive.Core.Tests.Songs
+{
+	public class SongUriTests
+	{
+		public static TheoryData<string, string, bool> TestData =>
+			new TheoryData<string, string, bool>
+			{
+				{ "test.ppl", "song:///test.ppl", false },
+				{ "test+test.ppl", "song:///test%2Btest.ppl", false },
+				{ "test&test.ppl", "song:///test%26test.ppl", false },
+				{ "test (test).ppl", "song:///test%20%28test%29.ppl", false },
+				{ "test [test].ppl", "song:///test%20%5Btest%5D.ppl", false },
+				{ "test äöüß.ppl", "song:///test%20%C3%A4%C3%B6%C3%BC%C3%9F.ppl", false },
+				{ "#test.ppl", "song:///%23test.ppl", false },
+				{ "subfolder/test.ppl", "song:///subfolder/test.ppl", false },
+				{ "subfolder\\test.ppl", "song:///subfolder/test.ppl", true },
+			};
+
+		[Theory]
+		[MemberData(nameof(TestData))]
+		public void GetUri(string filename, string uri, bool _)
+		{
+			Assert.Equal(uri, SongUri.GetUri(filename).OriginalString);
+		}
+
+		[Theory]
+		[MemberData(nameof(TestData))]
+		public void GetFilename(string filename, string uri, bool oneWayOnly)
+		{
+			if (oneWayOnly)
+			{
+				return;
+			}
+			Assert.Equal(filename, SongUri.GetFilename(new Uri(uri)));
+		}
+	}
+}

WordsLive.Core.Tests/WordsLive.Core.Tests.csproj

@@ -51,6 +51,7 @@
     </Compile>
     <Compile Include="DataTests.cs" />
     <Compile Include="ExtensionsTests.cs" />
+    <Compile Include="Songs\SongUriTests.cs" />
     <Compile Include="Songs\ChordTests.cs" />
     <Compile Include="Songs\SongPartTests.cs" />
     <Compile Include="Songs\SongSlideTests.cs" />

WordsLive.Core/MediaManager.cs

@@ -21,6 +21,7 @@
 using System.IO;
 using System.Linq;
 using System.Xml.Linq;
+using WordsLive.Core.Songs.Storage;
 
 namespace WordsLive.Core
 {
@@ -239,7 +240,7 @@ public static IEnumerable<Media> LoadPortfolio(string fileName)
 					{
 						foreach (Media m in from i in root.Element("order").Elements("item")
 											select (i.Attribute("mediatype").Value == "powerpraise-song" && !i.Element("file").Value.Contains('\\')) ?
-											LoadMediaMetadata(new Uri("song:///" + i.Element("file").Value), LoadOptions(i)) :
+											LoadMediaMetadata(SongUri.GetUri(i.Element("file").Value), LoadOptions(i)) :
 											LoadMediaMetadata(new Uri(i.Element("file").Value), LoadOptions(i)))
 						{
 							yield return m;
@@ -250,7 +251,7 @@ public static IEnumerable<Media> LoadPortfolio(string fileName)
 					else if (root.Attribute("version").Value == "2.2")
 					{
 						foreach (Media m in from i in root.Elements("item")
-													select MediaManager.LoadMediaMetadata(new Uri("song:///" + i.Element("file").Value), null))
+													select MediaManager.LoadMediaMetadata(SongUri.GetUri(i.Element("file").Value), null))
 						{
 							yield return m;
 						}
@@ -336,7 +337,7 @@ from m in enumerable
 		private static string GetMediaPathFromUri(Uri uri)
 		{
 			if (uri.Scheme == "song")
-				return Uri.UnescapeDataString(uri.AbsolutePath).Substring(1);
+				return SongUri.GetFilename(uri);
 
 			if (uri.IsFile)
 				return uri.LocalPath;

WordsLive.Core/Songs/Storage/LocalSongStorage.cs

@@ -59,10 +59,11 @@ public override IEnumerable<SongData> All()
 
 				try
 				{
-					var relativePath = new Uri(directory + Path.DirectorySeparatorChar)
+					var escapedRelativePath = new Uri(directory + Path.DirectorySeparatorChar)
 						.MakeRelativeUri(new Uri(file))
 						.ToString();
-					var song = new Song(new Uri("song:///" + relativePath), new SongUriResolver(this));
+					var relativePath = Uri.UnescapeDataString(escapedRelativePath);
+					var song = new Song(SongUri.GetUri(relativePath), new SongUriResolver(this));
 					data = SongData.Create(song);
 				}
 				catch { }
@@ -162,7 +163,7 @@ public override Uri TryRewriteUri(Uri uri)
 				if (filePath.StartsWith(rootPath, StringComparison.OrdinalIgnoreCase))
 				{
 					var relativePath = filePath.Substring(rootPath.Length).Replace(Path.DirectorySeparatorChar, '/');
-					return new Uri("song:///" + relativePath);
+					return SongUri.GetUri(relativePath);
 				}
 			}
 

WordsLive.Core/Songs/Storage/SongData.cs

@@ -128,7 +128,7 @@ public Uri Uri
 		{
 			get
 			{
-				return new Uri("song:///" + Filename);
+				return SongUri.GetUri(Filename);
 			}
 		}
 
@@ -143,7 +143,7 @@ public static SongData Create(Song song)
 			return new SongData
 			{
 				Title = song.Title,
-				Filename = Uri.UnescapeDataString(String.Join("", song.Uri.Segments.Skip(1))),
+				Filename = song.Uri.Scheme == "song" ? SongUri.GetFilename(song.Uri) : null,
 				Text = song.TextWithoutChords,
 				Translation = song.TranslationWithoutChords,
 				Copyright = String.Join(" ", song.Copyright.Split('\n').Select(line => line.Trim())),

WordsLive.Core/Songs/Storage/SongUri.cs

@@ -0,0 +1,53 @@
+/*
+ * WordsLive - worship projection software
+ * Copyright (c) 2013 Patrick Reisert
+ * 
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+using System;
+using System.Linq;
+
+namespace WordsLive.Core.Songs.Storage
+{
+	/// <summary>
+	/// Methods for handling "song://" URIs.
+	/// </summary>
+	public class SongUri
+	{
+		/// <summary>
+		/// Returns a "song://" URI for the given filename within the song storage folder.
+		/// </summary>
+		/// <param name="filename">The filename. Include the subfolder when the file is in a subfolder of the song storage folder.</param>
+		/// <returns>The "song://" URI with encoded special characters if needed.</returns>
+		public static Uri GetUri(string filename)
+		{
+			var escapedFilename = string.Join("/", filename.Split('/', '\\').Select(Uri.EscapeDataString));
+			return new Uri("song:///" + escapedFilename);
+		}
+
+		/// <summary>
+		/// Extracts the filename within the song storage folder from a "song://" URI.
+		/// </summary>
+		/// <param name="uri">The "song://" URI.</param>
+		/// <returns>The filename relative to the song storage folder. If the file is in a subfolder, then this includes the subfolder and the used delimiter is "/".</returns>
+		public static string GetFilename(Uri uri)
+		{
+			if (uri.Scheme != "song")
+				throw new ArgumentException("uri");
+
+			return Uri.UnescapeDataString(uri.AbsolutePath).Substring(1);
+		}
+	}
+}

WordsLive.Core/Songs/Storage/SongUriResolver.cs

@@ -61,7 +61,7 @@ public virtual Stream Get(Uri uri)
 		{
 			if (uri.Scheme == "song")
 			{
-				return (ForceStorage ?? DataManager.Songs).Get(GetFilename(uri)).Stream;
+				return (ForceStorage ?? DataManager.Songs).Get(SongUri.GetFilename(uri)).Stream;
 
 			}
 			else if (uri.IsFile)
@@ -85,7 +85,7 @@ public virtual async Task<Stream> GetAsync(Uri uri, CancellationToken cancellati
 		{
 			if (uri.Scheme == "song")
 			{
-				var entry = await (ForceStorage ?? DataManager.Songs).GetAsync(GetFilename(uri), cancellation);
+				var entry = await (ForceStorage ?? DataManager.Songs).GetAsync(SongUri.GetFilename(uri), cancellation);
 				return entry.Stream;
 			}
 			else if (uri.IsFile)
@@ -109,7 +109,7 @@ public virtual FileTransaction Put(Uri uri)
 		{
 			if (uri.Scheme == "song")
 			{
-				return (ForceStorage ?? DataManager.Songs).Put(GetFilename(uri));
+				return (ForceStorage ?? DataManager.Songs).Put(SongUri.GetFilename(uri));
 			}
 			else if (uri.IsFile)
 			{
@@ -120,13 +120,5 @@ public virtual FileTransaction Put(Uri uri)
 				throw new NotSupportedException();
 			}
 		}
-
-		private static string GetFilename(Uri uri)
-		{
-			if (uri.Scheme != "song")
-				throw new ArgumentException("uri");
-
-			return Uri.UnescapeDataString(uri.AbsolutePath).Substring(1);
-		}
 	}
 }

WordsLive.Core/WordsLive.Core.csproj

@@ -82,6 +82,7 @@
     <Compile Include="Songs\ISongElementWithSize.cs" />
     <Compile Include="Songs\SongMedia.cs" />
     <Compile Include="Songs\Storage\SongStorageEntry.cs" />
+    <Compile Include="Songs\Storage\SongUri.cs" />
     <Compile Include="Songs\Storage\SongUriResolver.cs" />
     <Compile Include="Songs\Storage\BackgroundStorage.cs" />
     <Compile Include="Songs\Storage\BackgroundStorageEntry.cs" />

WordsLive/Editor/EditorWindow.xaml.cs

@@ -212,7 +212,7 @@ private void SaveSongAs(Song song)
 
 			if (dlg.ShowDialog() == true)
 			{
-				song.Save(new Uri("song:///" + dlg.Filename));
+				song.Save(SongUri.GetUri(dlg.Filename));
 			}
 		}
 

WordsLive/MediaOrderList/MediaOrderItem.cs

@@ -21,6 +21,7 @@
 using System.Linq;
 using System.Windows.Media;
 using WordsLive.Core;
+using WordsLive.Core.Songs.Storage;
 
 namespace WordsLive.MediaOrderList
 {
@@ -75,7 +76,7 @@ public string Path
 				}
 				else if (Data.Uri.Scheme == "song")
 				{
-					return Uri.UnescapeDataString(Data.Uri.AbsolutePath).Substring(1);
+					return SongUri.GetFilename(Data.Uri);
 				}
 				else
 				{