| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.IO; |
| | | 4 | | using System.Linq; |
| | | 5 | | using MediaBrowser.Model.IO; |
| | | 6 | | using Microsoft.Extensions.Logging; |
| | | 7 | | |
| | | 8 | | namespace MediaBrowser.Controller.IO; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Helper methods for file system management. |
| | | 12 | | /// </summary> |
| | | 13 | | public static class FileSystemHelper |
| | | 14 | | { |
| | | 15 | | /// <summary> |
| | | 16 | | /// Deletes the file. |
| | | 17 | | /// </summary> |
| | | 18 | | /// <param name="fileSystem">The fileSystem.</param> |
| | | 19 | | /// <param name="path">The path.</param> |
| | | 20 | | /// <param name="logger">The logger.</param> |
| | | 21 | | public static void DeleteFile(IFileSystem fileSystem, string path, ILogger logger) |
| | | 22 | | { |
| | | 23 | | try |
| | | 24 | | { |
| | 0 | 25 | | fileSystem.DeleteFile(path); |
| | 0 | 26 | | } |
| | 0 | 27 | | catch (UnauthorizedAccessException ex) |
| | | 28 | | { |
| | 0 | 29 | | logger.LogError(ex, "Error deleting file {Path}", path); |
| | 0 | 30 | | } |
| | 0 | 31 | | catch (IOException ex) |
| | | 32 | | { |
| | 0 | 33 | | logger.LogError(ex, "Error deleting file {Path}", path); |
| | 0 | 34 | | } |
| | 0 | 35 | | } |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// Recursively delete empty folders. |
| | | 39 | | /// </summary> |
| | | 40 | | /// <param name="fileSystem">The fileSystem.</param> |
| | | 41 | | /// <param name="path">The path.</param> |
| | | 42 | | /// <param name="logger">The logger.</param> |
| | | 43 | | public static void DeleteEmptyFolders(IFileSystem fileSystem, string path, ILogger logger) |
| | | 44 | | { |
| | 6 | 45 | | foreach (var directory in fileSystem.GetDirectoryPaths(path)) |
| | | 46 | | { |
| | 0 | 47 | | DeleteEmptyFolders(fileSystem, directory, logger); |
| | 0 | 48 | | if (!fileSystem.GetFileSystemEntryPaths(directory).Any()) |
| | | 49 | | { |
| | | 50 | | try |
| | | 51 | | { |
| | 0 | 52 | | Directory.Delete(directory, false); |
| | 0 | 53 | | } |
| | 0 | 54 | | catch (UnauthorizedAccessException ex) |
| | | 55 | | { |
| | 0 | 56 | | logger.LogError(ex, "Error deleting directory {Path}", directory); |
| | 0 | 57 | | } |
| | 0 | 58 | | catch (IOException ex) |
| | | 59 | | { |
| | 0 | 60 | | logger.LogError(ex, "Error deleting directory {Path}", directory); |
| | 0 | 61 | | } |
| | | 62 | | } |
| | | 63 | | } |
| | 3 | 64 | | } |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// Resolves a single link hop for the specified path. |
| | | 68 | | /// </summary> |
| | | 69 | | /// <remarks> |
| | | 70 | | /// Returns <c>null</c> if the path is not a symbolic link or the filesystem does not support link resolution (e.g., |
| | | 71 | | /// </remarks> |
| | | 72 | | /// <param name="path">The file path to resolve.</param> |
| | | 73 | | /// <returns> |
| | | 74 | | /// A <see cref="FileInfo"/> representing the next link target if the path is a link; otherwise, <c>null</c>. |
| | | 75 | | /// </returns> |
| | | 76 | | private static FileInfo? Resolve(string path) |
| | | 77 | | { |
| | | 78 | | try |
| | | 79 | | { |
| | 11 | 80 | | return File.ResolveLinkTarget(path, returnFinalTarget: false) as FileInfo; |
| | | 81 | | } |
| | 0 | 82 | | catch (IOException) |
| | | 83 | | { |
| | | 84 | | // Filesystem doesn't support links (e.g., exFAT). |
| | 0 | 85 | | return null; |
| | | 86 | | } |
| | 11 | 87 | | } |
| | | 88 | | |
| | | 89 | | /// <summary> |
| | | 90 | | /// Gets the target of the specified file link. |
| | | 91 | | /// </summary> |
| | | 92 | | /// <remarks> |
| | | 93 | | /// This helper exists because of this upstream runtime issue; https://github.com/dotnet/runtime/issues/92128. |
| | | 94 | | /// </remarks> |
| | | 95 | | /// <param name="linkPath">The path of the file link.</param> |
| | | 96 | | /// <param name="returnFinalTarget">true to follow links to the final target; false to return the immediate next lin |
| | | 97 | | /// <returns> |
| | | 98 | | /// A <see cref="FileInfo"/> if the <paramref name="linkPath"/> is a link, regardless of if the target exists; other |
| | | 99 | | /// </returns> |
| | | 100 | | public static FileInfo? ResolveLinkTarget(string linkPath, bool returnFinalTarget = false) |
| | | 101 | | { |
| | | 102 | | // Check if the file exists so the native resolve handler won't throw at us. |
| | 11 | 103 | | if (!File.Exists(linkPath)) |
| | | 104 | | { |
| | 0 | 105 | | return null; |
| | | 106 | | } |
| | | 107 | | |
| | 11 | 108 | | if (!returnFinalTarget) |
| | | 109 | | { |
| | 0 | 110 | | return Resolve(linkPath); |
| | | 111 | | } |
| | | 112 | | |
| | 11 | 113 | | var targetInfo = Resolve(linkPath); |
| | 11 | 114 | | if (targetInfo is null || !targetInfo.Exists) |
| | | 115 | | { |
| | 11 | 116 | | return targetInfo; |
| | | 117 | | } |
| | | 118 | | |
| | 0 | 119 | | var currentPath = targetInfo.FullName; |
| | 0 | 120 | | var visited = new HashSet<string>(StringComparer.Ordinal) { linkPath, currentPath }; |
| | | 121 | | |
| | | 122 | | while (true) |
| | | 123 | | { |
| | 0 | 124 | | var linkInfo = Resolve(currentPath); |
| | 0 | 125 | | if (linkInfo is null) |
| | | 126 | | { |
| | | 127 | | break; |
| | | 128 | | } |
| | | 129 | | |
| | 0 | 130 | | var targetPath = linkInfo.FullName; |
| | | 131 | | |
| | | 132 | | // If an infinite loop is detected, return the file info for the |
| | | 133 | | // first link in the loop we encountered. |
| | 0 | 134 | | if (!visited.Add(targetPath)) |
| | | 135 | | { |
| | 0 | 136 | | return new FileInfo(targetPath); |
| | | 137 | | } |
| | | 138 | | |
| | 0 | 139 | | targetInfo = linkInfo; |
| | 0 | 140 | | currentPath = targetPath; |
| | | 141 | | |
| | | 142 | | // Exit if the target doesn't exist, so the native resolve handler won't throw at us. |
| | 0 | 143 | | if (!targetInfo.Exists) |
| | | 144 | | { |
| | | 145 | | break; |
| | | 146 | | } |
| | | 147 | | } |
| | | 148 | | |
| | 0 | 149 | | return targetInfo; |
| | | 150 | | } |
| | | 151 | | |
| | | 152 | | /// <summary> |
| | | 153 | | /// Gets the target of the specified file link. |
| | | 154 | | /// </summary> |
| | | 155 | | /// <remarks> |
| | | 156 | | /// This helper exists because of this upstream runtime issue; https://github.com/dotnet/runtime/issues/92128. |
| | | 157 | | /// </remarks> |
| | | 158 | | /// <param name="fileInfo">The file info of the file link.</param> |
| | | 159 | | /// <param name="returnFinalTarget">true to follow links to the final target; false to return the immediate next lin |
| | | 160 | | /// <returns> |
| | | 161 | | /// A <see cref="FileInfo"/> if the <paramref name="fileInfo"/> is a link, regardless of if the target exists; other |
| | | 162 | | /// </returns> |
| | | 163 | | public static FileInfo? ResolveLinkTarget(FileInfo fileInfo, bool returnFinalTarget = false) |
| | | 164 | | { |
| | 11 | 165 | | ArgumentNullException.ThrowIfNull(fileInfo); |
| | | 166 | | |
| | 11 | 167 | | return ResolveLinkTarget(fileInfo.FullName, returnFinalTarget); |
| | | 168 | | } |
| | | 169 | | |
| | | 170 | | /// <summary> |
| | | 171 | | /// Combines a caller supplied name with a parent directory, making sure the name cannot escape that directory. |
| | | 172 | | /// </summary> |
| | | 173 | | /// <param name="parentPath">The directory the name has to resolve inside of.</param> |
| | | 174 | | /// <param name="name">The name of the child.</param> |
| | | 175 | | /// <returns> |
| | | 176 | | /// The full path of the child, or <c>null</c> if <paramref name="name"/> is not the name of a direct child |
| | | 177 | | /// of <paramref name="parentPath"/>. |
| | | 178 | | /// </returns> |
| | | 179 | | public static string? GetChildPath(string parentPath, string name) |
| | | 180 | | { |
| | 49 | 181 | | if (string.IsNullOrWhiteSpace(name) || name.Contains('\0', StringComparison.Ordinal)) |
| | | 182 | | { |
| | 3 | 183 | | return null; |
| | | 184 | | } |
| | | 185 | | |
| | | 186 | | // Rejects directory separators, and on Windows also volume separators, as those make the name more than a singl |
| | 46 | 187 | | if (!string.Equals(Path.GetFileName(name), name, StringComparison.Ordinal)) |
| | | 188 | | { |
| | 13 | 189 | | return null; |
| | | 190 | | } |
| | | 191 | | |
| | 33 | 192 | | var fullPath = Path.GetFullPath(Path.Combine(parentPath, name)); |
| | 33 | 193 | | var fullParentPath = Path.TrimEndingDirectorySeparator(Path.GetFullPath(parentPath)); |
| | | 194 | | |
| | | 195 | | // Catches the remaining relative names, "." and "..", which are valid single segments. |
| | 33 | 196 | | if (!string.Equals(Path.GetDirectoryName(fullPath), fullParentPath, StringComparison.Ordinal)) |
| | | 197 | | { |
| | 7 | 198 | | return null; |
| | | 199 | | } |
| | | 200 | | |
| | | 201 | | // Windows strips trailing dots and spaces, so a name like "..." resolves to the parent directory itself |
| | | 202 | | // and a name like "Movies." to a different child. Reject anything normalization did not leave intact. |
| | 26 | 203 | | return string.Equals(Path.GetFileName(fullPath), name, StringComparison.Ordinal) ? fullPath : null; |
| | | 204 | | } |
| | | 205 | | } |