Support subfolders in local song storage (#42)

This change allows subfolders in the local song storage. It changes the song list to work recursively and also allows to use e.g. "Existing Folder/Song name" when saving a new song. Otherwise this does not really advertise the subfolder possibility, existing subfolders can be used, but there is no special support for them in the UI.

- Support subfolders in local song storage
- Support saving into existing local subfolders

Author: aspettl

WordsLive.Core/Songs/Storage/LocalSongStorage.cs

@@ -53,13 +53,16 @@ public override IEnumerable<SongData> All()
 			// TODO: implement caching
 			SongData data;
 
-			foreach (string file in Directory.GetFiles(directory))
+			foreach (string file in Directory.EnumerateFiles(directory, "*.*", SearchOption.AllDirectories))
 			{
 				data = null;
 
 				try
 				{
-					var song = new Song(new Uri("song:///" + Path.GetFileName(file)), new SongUriResolver(this));
+					var relativePath = new Uri(directory + Path.DirectorySeparatorChar)
+						.MakeRelativeUri(new Uri(file))
+						.ToString();
+					var song = new Song(new Uri("song:///" + relativePath), new SongUriResolver(this));
 					data = SongData.Create(song);
 				}
 				catch { }
@@ -84,7 +87,7 @@ public override Task<IEnumerable<SongData>> AllAsync()
 		/// <exception cref="FileNotFoundException">The resource was not found.</exception>
 		public override SongStorageEntry Get(string name)
 		{
-			if (name.Contains("\\") || name.Contains("/"))
+			if (Path.IsPathRooted(name))
 				throw new ArgumentException("Song filename must not contain a full path.");
 
 			string fullPath = Path.Combine(directory, name);
@@ -125,25 +128,41 @@ public override bool Exists(string name)
 			return File.Exists(Path.Combine(directory, name));
 		}
 
+		public override bool IsValidName(string name)
+		{
+			if (string.IsNullOrEmpty(name) || name.IndexOfAny(Path.GetInvalidPathChars()) != -1)
+				return false;
+
+			if (Path.IsPathRooted(name))
+				return false;
+
+			var fileName = Path.GetFileName(name);
+			if (string.IsNullOrEmpty(fileName) || fileName.IndexOfAny(Path.GetInvalidFileNameChars()) != -1)
+				return false;
+
+			var subdirectoryName = Path.GetDirectoryName(name);
+			if (!Directory.Exists(Path.Combine(directory, subdirectoryName)))
+				return false;
+
+			var fullPath = Path.GetFullPath(Path.Combine(directory, name));
+			if (!fullPath.StartsWith(directory + Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase))
+				return false;
+
+			return true;
+		}
+
 		public override Uri TryRewriteUri(Uri uri)
 		{
 			if (uri.IsFile)
 			{
 				// rewrite local song URIs to song:// schema
-				var store = DataManager.Songs as LocalSongStorage;
-				try
-				{
-					FileInfo fi1 = new FileInfo(Uri.UnescapeDataString(uri.AbsolutePath));
-					var name = Uri.UnescapeDataString(uri.Segments[uri.Segments.Length - 1]);
-					var fi2 = store.GetLocal(name);
-					if (fi1.Exists && fi2.Exists && fi1.FullName == fi2.FullName)
-					{
-						return new Uri("song:///" + name);
-					}
-				}
-				catch (FileNotFoundException)
+				var filePath = Path.GetFullPath(Uri.UnescapeDataString(uri.LocalPath));
+				var rootPath = Path.GetFullPath(directory) + Path.DirectorySeparatorChar;
+
+				if (filePath.StartsWith(rootPath, StringComparison.OrdinalIgnoreCase))
 				{
-					return uri;
+					var relativePath = filePath.Substring(rootPath.Length).Replace(Path.DirectorySeparatorChar, '/');
+					return new Uri("song:///" + relativePath);
 				}
 			}
 

WordsLive.Core/Songs/Storage/SongData.cs

@@ -17,7 +17,6 @@
  */
 
 using System;
-using System.IO;
 using System.Linq;
 using System.Text.RegularExpressions;
 using Newtonsoft.Json;
@@ -144,7 +143,7 @@ public static SongData Create(Song song)
 			return new SongData
 			{
 				Title = song.Title,
-				Filename = Path.GetFileName(Uri.UnescapeDataString(song.Uri.Segments.Last())),
+				Filename = Uri.UnescapeDataString(String.Join("", song.Uri.Segments.Skip(1))),
 				Text = song.TextWithoutChords,
 				Translation = song.TranslationWithoutChords,
 				Copyright = String.Join(" ", song.Copyright.Split('\n').Select(line => line.Trim())),

WordsLive.Core/Songs/Storage/SongStorage.cs

@@ -112,6 +112,14 @@ public virtual int Count()
 
 		public abstract bool Exists(string name);
 
+		/// <summary>
+		/// Check if the given name of the song is allowed (independent of whether it already exists
+		/// or not; checks the general format and checks especially for invalid characters).
+		/// </summary>
+		/// <param name="name">The name of the song.</param>
+		/// <returns>True if the song name can be used for saving a song.</returns>
+		public abstract bool IsValidName(string name);
+
 		//public Song Read(string name, ISongReader reader)
 		//{
 		//	throw new NotImplementedException();

WordsLive/Editor/SaveFilenameDialog.xaml.cs

@@ -17,7 +17,6 @@
  */
 
 using System.ComponentModel;
-using System.IO;
 using System.Windows;
 using WordsLive.Core;
 using WordsLive.Resources;
@@ -103,7 +102,7 @@ public string this[string name]
 				switch (name)
 				{
 					case "FilenameWithoutExtension":
-						if (string.IsNullOrEmpty(this.filename) || this.filename.IndexOfAny(Path.GetInvalidFileNameChars()) != -1)
+						if (!DataManager.Songs.IsValidName(this.filename))
 							return Resource.sfInvalidFilename;
 
 						break;