using System; using System.Diagnostics.Contracts; using System.IO; using System.Linq; using System.Text.RegularExpressions; namespace StardewModdingAPI.Toolkit.Utilities { /// Provides utilities for normalising file paths. public static class PathUtilities { /********* ** Fields *********/ /// The possible directory separator characters in a file path. private static readonly char[] PossiblePathSeparators = new[] { '/', '\\', Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar }.Distinct().ToArray(); /// The preferred directory separator chaeacter in an asset key. private static readonly string PreferredPathSeparator = Path.DirectorySeparatorChar.ToString(); /********* ** Public methods *********/ /// Get the segments from a path (e.g. /usr/bin/boop => usr, bin, and boop). /// The path to split. /// The number of segments to match. Any additional segments will be merged into the last returned part. public static string[] GetSegments(string path, int? limit = null) { return limit.HasValue ? path.Split(PathUtilities.PossiblePathSeparators, limit.Value, StringSplitOptions.RemoveEmptyEntries) : path.Split(PathUtilities.PossiblePathSeparators, StringSplitOptions.RemoveEmptyEntries); } /// Normalise path separators in a file path. /// The file path to normalise. [Pure] public static string NormalisePathSeparators(string path) { string[] parts = PathUtilities.GetSegments(path); string normalised = string.Join(PathUtilities.PreferredPathSeparator, parts); if (path.StartsWith(PathUtilities.PreferredPathSeparator)) normalised = PathUtilities.PreferredPathSeparator + normalised; // keep root slash return normalised; } /// Get a directory or file path relative to a given source path. /// The source folder path. /// The target folder or file path. [Pure] public static string GetRelativePath(string sourceDir, string targetPath) { // convert to URIs Uri from = new Uri(sourceDir.TrimEnd(PathUtilities.PossiblePathSeparators) + "/"); Uri to = new Uri(targetPath.TrimEnd(PathUtilities.PossiblePathSeparators) + "/"); if (from.Scheme != to.Scheme) throw new InvalidOperationException($"Can't get path for '{targetPath}' relative to '{sourceDir}'."); // get relative path string relative = PathUtilities.NormalisePathSeparators(Uri.UnescapeDataString(from.MakeRelativeUri(to).ToString())); if (relative == "") relative = "./"; return relative; } /// Get whether a path is relative and doesn't try to climb out of its containing folder (e.g. doesn't contain ../). /// The path to check. public static bool IsSafeRelativePath(string path) { if (string.IsNullOrWhiteSpace(path)) return true; return !Path.IsPathRooted(path) && PathUtilities.GetSegments(path).All(segment => segment.Trim() != ".."); } /// Get whether a string is a valid 'slug', containing only basic characters that are safe in all contexts (e.g. filenames, URLs, etc). /// The string to check. public static bool IsSlug(string str) { return !Regex.IsMatch(str, "[^a-z0-9_.-]", RegexOptions.IgnoreCase); } } }