| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Globalization; |
| | | 4 | | using System.IO; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Security; |
| | | 7 | | using Jellyfin.Extensions; |
| | | 8 | | using MediaBrowser.Common.Configuration; |
| | | 9 | | using MediaBrowser.Model.IO; |
| | | 10 | | using Microsoft.Extensions.Logging; |
| | | 11 | | |
| | | 12 | | namespace Emby.Server.Implementations.IO |
| | | 13 | | { |
| | | 14 | | /// <summary> |
| | | 15 | | /// Class ManagedFileSystem. |
| | | 16 | | /// </summary> |
| | | 17 | | public class ManagedFileSystem : IFileSystem |
| | | 18 | | { |
| | 2 | 19 | | private static readonly bool _isEnvironmentCaseInsensitive = OperatingSystem.IsWindows(); |
| | 2 | 20 | | private static readonly char[] _invalidPathCharacters = |
| | 2 | 21 | | { |
| | 2 | 22 | | '\"', '<', '>', '|', '\0', |
| | 2 | 23 | | (char)1, (char)2, (char)3, (char)4, (char)5, (char)6, (char)7, (char)8, (char)9, (char)10, |
| | 2 | 24 | | (char)11, (char)12, (char)13, (char)14, (char)15, (char)16, (char)17, (char)18, (char)19, (char)20, |
| | 2 | 25 | | (char)21, (char)22, (char)23, (char)24, (char)25, (char)26, (char)27, (char)28, (char)29, (char)30, |
| | 2 | 26 | | (char)31, ':', '*', '?', '\\', '/' |
| | 2 | 27 | | }; |
| | | 28 | | |
| | | 29 | | private readonly ILogger<ManagedFileSystem> _logger; |
| | | 30 | | private readonly List<IShortcutHandler> _shortcutHandlers; |
| | | 31 | | private readonly string _tempPath; |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Initializes a new instance of the <see cref="ManagedFileSystem"/> class. |
| | | 35 | | /// </summary> |
| | | 36 | | /// <param name="logger">The <see cref="ILogger"/> instance to use.</param> |
| | | 37 | | /// <param name="applicationPaths">The <see cref="IApplicationPaths"/> instance to use.</param> |
| | | 38 | | /// <param name="shortcutHandlers">the <see cref="IShortcutHandler"/>'s to use.</param> |
| | | 39 | | public ManagedFileSystem( |
| | | 40 | | ILogger<ManagedFileSystem> logger, |
| | | 41 | | IApplicationPaths applicationPaths, |
| | | 42 | | IEnumerable<IShortcutHandler> shortcutHandlers) |
| | | 43 | | { |
| | 40 | 44 | | _logger = logger; |
| | 40 | 45 | | _tempPath = applicationPaths.TempDirectory; |
| | 40 | 46 | | _shortcutHandlers = shortcutHandlers.ToList(); |
| | 40 | 47 | | } |
| | | 48 | | |
| | | 49 | | /// <summary> |
| | | 50 | | /// Determines whether the specified filename is shortcut. |
| | | 51 | | /// </summary> |
| | | 52 | | /// <param name="filename">The filename.</param> |
| | | 53 | | /// <returns><c>true</c> if the specified filename is shortcut; otherwise, <c>false</c>.</returns> |
| | | 54 | | /// <exception cref="ArgumentNullException"><paramref name="filename"/> is <c>null</c>.</exception> |
| | | 55 | | public virtual bool IsShortcut(string filename) |
| | | 56 | | { |
| | 132 | 57 | | ArgumentException.ThrowIfNullOrEmpty(filename); |
| | | 58 | | |
| | 132 | 59 | | var extension = Path.GetExtension(filename); |
| | 132 | 60 | | return _shortcutHandlers.Any(i => string.Equals(extension, i.Extension, StringComparison.OrdinalIgnoreCase)) |
| | | 61 | | } |
| | | 62 | | |
| | | 63 | | /// <summary> |
| | | 64 | | /// Resolves the shortcut. |
| | | 65 | | /// </summary> |
| | | 66 | | /// <param name="filename">The filename.</param> |
| | | 67 | | /// <returns>System.String.</returns> |
| | | 68 | | /// <exception cref="ArgumentNullException"><paramref name="filename"/> is <c>null</c>.</exception> |
| | | 69 | | public virtual string? ResolveShortcut(string filename) |
| | | 70 | | { |
| | 0 | 71 | | ArgumentException.ThrowIfNullOrEmpty(filename); |
| | | 72 | | |
| | 0 | 73 | | var extension = Path.GetExtension(filename); |
| | 0 | 74 | | var handler = _shortcutHandlers.Find(i => string.Equals(extension, i.Extension, StringComparison.OrdinalIgno |
| | | 75 | | |
| | 0 | 76 | | return handler?.Resolve(filename); |
| | | 77 | | } |
| | | 78 | | |
| | | 79 | | /// <inheritdoc /> |
| | | 80 | | public virtual string MakeAbsolutePath(string folderPath, string filePath) |
| | | 81 | | { |
| | | 82 | | // path is actually a stream |
| | 4 | 83 | | if (string.IsNullOrWhiteSpace(filePath)) |
| | | 84 | | { |
| | 0 | 85 | | return filePath; |
| | | 86 | | } |
| | | 87 | | |
| | 4 | 88 | | var isAbsolutePath = Path.IsPathRooted(filePath) && (!OperatingSystem.IsWindows() || filePath[0] != '\\'); |
| | | 89 | | |
| | 4 | 90 | | if (isAbsolutePath) |
| | | 91 | | { |
| | | 92 | | // absolute local path |
| | 1 | 93 | | return filePath; |
| | | 94 | | } |
| | | 95 | | |
| | | 96 | | // unc path |
| | 3 | 97 | | if (filePath.StartsWith(@"\\", StringComparison.Ordinal)) |
| | | 98 | | { |
| | 0 | 99 | | return filePath; |
| | | 100 | | } |
| | | 101 | | |
| | 3 | 102 | | var filePathSpan = filePath.AsSpan(); |
| | | 103 | | |
| | | 104 | | // relative path on windows |
| | 3 | 105 | | if (filePath[0] == '\\') |
| | | 106 | | { |
| | 0 | 107 | | filePathSpan = filePathSpan.Slice(1); |
| | | 108 | | } |
| | | 109 | | |
| | | 110 | | try |
| | | 111 | | { |
| | 3 | 112 | | return Path.GetFullPath(Path.Join(folderPath, filePathSpan)); |
| | | 113 | | } |
| | 0 | 114 | | catch (ArgumentException) |
| | | 115 | | { |
| | 0 | 116 | | return filePath; |
| | | 117 | | } |
| | 0 | 118 | | catch (PathTooLongException) |
| | | 119 | | { |
| | 0 | 120 | | return filePath; |
| | | 121 | | } |
| | 0 | 122 | | catch (NotSupportedException) |
| | | 123 | | { |
| | 0 | 124 | | return filePath; |
| | | 125 | | } |
| | 3 | 126 | | } |
| | | 127 | | |
| | | 128 | | /// <summary> |
| | | 129 | | /// Creates the shortcut. |
| | | 130 | | /// </summary> |
| | | 131 | | /// <param name="shortcutPath">The shortcut path.</param> |
| | | 132 | | /// <param name="target">The target.</param> |
| | | 133 | | /// <exception cref="ArgumentNullException">The shortcutPath or target is null.</exception> |
| | | 134 | | public virtual void CreateShortcut(string shortcutPath, string target) |
| | | 135 | | { |
| | 0 | 136 | | ArgumentException.ThrowIfNullOrEmpty(shortcutPath); |
| | 0 | 137 | | ArgumentException.ThrowIfNullOrEmpty(target); |
| | | 138 | | |
| | 0 | 139 | | var extension = Path.GetExtension(shortcutPath); |
| | 0 | 140 | | var handler = _shortcutHandlers.Find(i => string.Equals(extension, i.Extension, StringComparison.OrdinalIgno |
| | | 141 | | |
| | 0 | 142 | | if (handler is not null) |
| | | 143 | | { |
| | 0 | 144 | | handler.Create(shortcutPath, target); |
| | | 145 | | } |
| | | 146 | | else |
| | | 147 | | { |
| | 0 | 148 | | throw new NotImplementedException(); |
| | | 149 | | } |
| | | 150 | | } |
| | | 151 | | |
| | | 152 | | /// <inheritdoc /> |
| | | 153 | | public void MoveDirectory(string source, string destination) |
| | | 154 | | { |
| | | 155 | | try |
| | | 156 | | { |
| | 0 | 157 | | Directory.Move(source, destination); |
| | 0 | 158 | | } |
| | 0 | 159 | | catch (IOException) |
| | | 160 | | { |
| | | 161 | | // Cross device move requires a copy |
| | 0 | 162 | | Directory.CreateDirectory(destination); |
| | 0 | 163 | | foreach (string file in Directory.GetFiles(source)) |
| | | 164 | | { |
| | 0 | 165 | | File.Copy(file, Path.Combine(destination, Path.GetFileName(file)), true); |
| | | 166 | | } |
| | | 167 | | |
| | 0 | 168 | | Directory.Delete(source, true); |
| | 0 | 169 | | } |
| | 0 | 170 | | } |
| | | 171 | | |
| | | 172 | | /// <summary> |
| | | 173 | | /// Returns a <see cref="FileSystemMetadata"/> object for the specified file or directory path. |
| | | 174 | | /// </summary> |
| | | 175 | | /// <param name="path">A path to a file or directory.</param> |
| | | 176 | | /// <returns>A <see cref="FileSystemMetadata"/> object.</returns> |
| | | 177 | | /// <remarks>If the specified path points to a directory, the returned <see cref="FileSystemMetadata"/> object's |
| | | 178 | | /// <see cref="FileSystemMetadata.IsDirectory"/> property will be set to true and all other properties will refl |
| | | 179 | | public virtual FileSystemMetadata GetFileSystemInfo(string path) |
| | | 180 | | { |
| | | 181 | | // Take a guess to try and avoid two file system hits, but we'll double-check by calling Exists |
| | 30 | 182 | | if (Path.HasExtension(path)) |
| | | 183 | | { |
| | 0 | 184 | | var fileInfo = new FileInfo(path); |
| | | 185 | | |
| | 0 | 186 | | if (fileInfo.Exists) |
| | | 187 | | { |
| | 0 | 188 | | return GetFileSystemMetadata(fileInfo); |
| | | 189 | | } |
| | | 190 | | |
| | 0 | 191 | | return GetFileSystemMetadata(new DirectoryInfo(path)); |
| | | 192 | | } |
| | | 193 | | else |
| | | 194 | | { |
| | 30 | 195 | | var fileInfo = new DirectoryInfo(path); |
| | | 196 | | |
| | 30 | 197 | | if (fileInfo.Exists) |
| | | 198 | | { |
| | 30 | 199 | | return GetFileSystemMetadata(fileInfo); |
| | | 200 | | } |
| | | 201 | | |
| | 0 | 202 | | return GetFileSystemMetadata(new FileInfo(path)); |
| | | 203 | | } |
| | | 204 | | } |
| | | 205 | | |
| | | 206 | | /// <summary> |
| | | 207 | | /// Returns a <see cref="FileSystemMetadata"/> object for the specified file path. |
| | | 208 | | /// </summary> |
| | | 209 | | /// <param name="path">A path to a file.</param> |
| | | 210 | | /// <returns>A <see cref="FileSystemMetadata"/> object.</returns> |
| | | 211 | | /// <remarks><para>If the specified path points to a directory, the returned <see cref="FileSystemMetadata"/> ob |
| | | 212 | | /// <see cref="FileSystemMetadata.IsDirectory"/> property and the <see cref="FileSystemMetadata.Exists"/> proper |
| | | 213 | | /// <para>For automatic handling of files <b>and</b> directories, use <see cref="GetFileSystemInfo"/>.</para></r |
| | | 214 | | public virtual FileSystemMetadata GetFileInfo(string path) |
| | | 215 | | { |
| | 1 | 216 | | var fileInfo = new FileInfo(path); |
| | | 217 | | |
| | 1 | 218 | | return GetFileSystemMetadata(fileInfo); |
| | | 219 | | } |
| | | 220 | | |
| | | 221 | | /// <summary> |
| | | 222 | | /// Returns a <see cref="FileSystemMetadata"/> object for the specified directory path. |
| | | 223 | | /// </summary> |
| | | 224 | | /// <param name="path">A path to a directory.</param> |
| | | 225 | | /// <returns>A <see cref="FileSystemMetadata"/> object.</returns> |
| | | 226 | | /// <remarks><para>If the specified path points to a file, the returned <see cref="FileSystemMetadata"/> object' |
| | | 227 | | /// <see cref="FileSystemMetadata.IsDirectory"/> property will be set to true and the <see cref="FileSystemMetad |
| | | 228 | | /// <para>For automatic handling of files <b>and</b> directories, use <see cref="GetFileSystemInfo"/>.</para></r |
| | | 229 | | public virtual FileSystemMetadata GetDirectoryInfo(string path) |
| | | 230 | | { |
| | 116 | 231 | | var fileInfo = new DirectoryInfo(path); |
| | | 232 | | |
| | 116 | 233 | | return GetFileSystemMetadata(fileInfo); |
| | | 234 | | } |
| | | 235 | | |
| | | 236 | | private FileSystemMetadata GetFileSystemMetadata(FileSystemInfo info) |
| | | 237 | | { |
| | 308 | 238 | | var result = new FileSystemMetadata |
| | 308 | 239 | | { |
| | 308 | 240 | | Exists = info.Exists, |
| | 308 | 241 | | FullName = info.FullName, |
| | 308 | 242 | | Extension = info.Extension, |
| | 308 | 243 | | Name = info.Name |
| | 308 | 244 | | }; |
| | | 245 | | |
| | 308 | 246 | | if (result.Exists) |
| | | 247 | | { |
| | 308 | 248 | | result.IsDirectory = info is DirectoryInfo || (info.Attributes & FileAttributes.Directory) == FileAttrib |
| | | 249 | | |
| | | 250 | | // if (!result.IsDirectory) |
| | | 251 | | // { |
| | | 252 | | // result.IsHidden = (info.Attributes & FileAttributes.Hidden) == FileAttributes.Hidden; |
| | | 253 | | // } |
| | | 254 | | |
| | 308 | 255 | | if (info is FileInfo fileInfo) |
| | | 256 | | { |
| | 42 | 257 | | result.Length = fileInfo.Length; |
| | | 258 | | |
| | | 259 | | // Issue #2354 get the size of files behind symbolic links. Also Enum.HasFlag is bad as it boxes! |
| | 42 | 260 | | if ((fileInfo.Attributes & FileAttributes.ReparsePoint) == FileAttributes.ReparsePoint) |
| | | 261 | | { |
| | | 262 | | try |
| | | 263 | | { |
| | 1 | 264 | | using (var fileHandle = File.OpenHandle(fileInfo.FullName, FileMode.Open, FileAccess.Read, F |
| | | 265 | | { |
| | 0 | 266 | | result.Length = RandomAccess.GetLength(fileHandle); |
| | 0 | 267 | | } |
| | 0 | 268 | | } |
| | 1 | 269 | | catch (FileNotFoundException ex) |
| | | 270 | | { |
| | | 271 | | // Dangling symlinks cannot be detected before opening the file unfortunately... |
| | 1 | 272 | | _logger.LogError(ex, "Reading the file size of the symlink at {Path} failed. Marking the fil |
| | 1 | 273 | | result.Exists = false; |
| | 1 | 274 | | } |
| | 0 | 275 | | catch (UnauthorizedAccessException ex) |
| | | 276 | | { |
| | 0 | 277 | | _logger.LogError(ex, "Reading the file at {Path} failed due to a permissions exception.", fi |
| | 0 | 278 | | } |
| | 0 | 279 | | catch (IOException ex) |
| | | 280 | | { |
| | | 281 | | // IOException generally means the file is not accessible due to filesystem issues |
| | | 282 | | // Catch this exception and mark the file as not exist to ignore it |
| | 0 | 283 | | _logger.LogError(ex, "Reading the file at {Path} failed due to an IO Exception. Marking the |
| | 0 | 284 | | result.Exists = false; |
| | 0 | 285 | | } |
| | | 286 | | } |
| | | 287 | | } |
| | | 288 | | |
| | 308 | 289 | | result.CreationTimeUtc = GetCreationTimeUtc(info); |
| | 308 | 290 | | result.LastWriteTimeUtc = GetLastWriteTimeUtc(info); |
| | | 291 | | } |
| | | 292 | | else |
| | | 293 | | { |
| | 0 | 294 | | result.IsDirectory = info is DirectoryInfo; |
| | | 295 | | } |
| | | 296 | | |
| | 308 | 297 | | return result; |
| | | 298 | | } |
| | | 299 | | |
| | | 300 | | /// <summary> |
| | | 301 | | /// Takes a filename and removes invalid characters. |
| | | 302 | | /// </summary> |
| | | 303 | | /// <param name="filename">The filename.</param> |
| | | 304 | | /// <returns>System.String.</returns> |
| | | 305 | | /// <exception cref="ArgumentNullException">The filename is null.</exception> |
| | | 306 | | public string GetValidFilename(string filename) |
| | | 307 | | { |
| | 7 | 308 | | var first = filename.IndexOfAny(_invalidPathCharacters); |
| | 7 | 309 | | if (first == -1) |
| | | 310 | | { |
| | | 311 | | // Fast path for clean strings |
| | 4 | 312 | | return filename; |
| | | 313 | | } |
| | | 314 | | |
| | 3 | 315 | | return string.Create( |
| | 3 | 316 | | filename.Length, |
| | 3 | 317 | | (filename, _invalidPathCharacters, first), |
| | 3 | 318 | | (chars, state) => |
| | 3 | 319 | | { |
| | 3 | 320 | | state.filename.AsSpan().CopyTo(chars); |
| | 3 | 321 | | |
| | 3 | 322 | | chars[state.first++] = ' '; |
| | 3 | 323 | | |
| | 3 | 324 | | var len = chars.Length; |
| | 3 | 325 | | foreach (var c in state._invalidPathCharacters) |
| | 3 | 326 | | { |
| | 3 | 327 | | for (int i = state.first; i < len; i++) |
| | 3 | 328 | | { |
| | 3 | 329 | | if (chars[i] == c) |
| | 3 | 330 | | { |
| | 3 | 331 | | chars[i] = ' '; |
| | 3 | 332 | | } |
| | 3 | 333 | | } |
| | 3 | 334 | | } |
| | 3 | 335 | | }); |
| | | 336 | | } |
| | | 337 | | |
| | | 338 | | /// <summary> |
| | | 339 | | /// Gets the creation time UTC. |
| | | 340 | | /// </summary> |
| | | 341 | | /// <param name="info">The info.</param> |
| | | 342 | | /// <returns>DateTime.</returns> |
| | | 343 | | public DateTime GetCreationTimeUtc(FileSystemInfo info) |
| | | 344 | | { |
| | | 345 | | // This could throw an error on some file systems that have dates out of range |
| | | 346 | | try |
| | | 347 | | { |
| | 308 | 348 | | return info.CreationTimeUtc; |
| | | 349 | | } |
| | 0 | 350 | | catch (Exception ex) |
| | | 351 | | { |
| | 0 | 352 | | _logger.LogError(ex, "Error determining CreationTimeUtc for {FullName}", info.FullName); |
| | 0 | 353 | | return DateTime.MinValue; |
| | | 354 | | } |
| | 308 | 355 | | } |
| | | 356 | | |
| | | 357 | | /// <inheritdoc /> |
| | | 358 | | public virtual DateTime GetCreationTimeUtc(string path) |
| | | 359 | | { |
| | 0 | 360 | | return GetCreationTimeUtc(GetFileSystemInfo(path)); |
| | | 361 | | } |
| | | 362 | | |
| | | 363 | | /// <inheritdoc /> |
| | | 364 | | public virtual DateTime GetCreationTimeUtc(FileSystemMetadata info) |
| | | 365 | | { |
| | 0 | 366 | | return info.CreationTimeUtc; |
| | | 367 | | } |
| | | 368 | | |
| | | 369 | | /// <inheritdoc /> |
| | | 370 | | public virtual DateTime GetLastWriteTimeUtc(FileSystemMetadata info) |
| | | 371 | | { |
| | 0 | 372 | | return info.LastWriteTimeUtc; |
| | | 373 | | } |
| | | 374 | | |
| | | 375 | | /// <summary> |
| | | 376 | | /// Gets the creation time UTC. |
| | | 377 | | /// </summary> |
| | | 378 | | /// <param name="info">The info.</param> |
| | | 379 | | /// <returns>DateTime.</returns> |
| | | 380 | | public DateTime GetLastWriteTimeUtc(FileSystemInfo info) |
| | | 381 | | { |
| | | 382 | | // This could throw an error on some file systems that have dates out of range |
| | | 383 | | try |
| | | 384 | | { |
| | 308 | 385 | | return info.LastWriteTimeUtc; |
| | | 386 | | } |
| | 0 | 387 | | catch (Exception ex) |
| | | 388 | | { |
| | 0 | 389 | | _logger.LogError(ex, "Error determining LastAccessTimeUtc for {FullName}", info.FullName); |
| | 0 | 390 | | return DateTime.MinValue; |
| | | 391 | | } |
| | 308 | 392 | | } |
| | | 393 | | |
| | | 394 | | /// <inheritdoc /> |
| | | 395 | | public virtual DateTime GetLastWriteTimeUtc(string path) |
| | | 396 | | { |
| | 0 | 397 | | return GetLastWriteTimeUtc(GetFileSystemInfo(path)); |
| | | 398 | | } |
| | | 399 | | |
| | | 400 | | /// <inheritdoc /> |
| | | 401 | | public virtual void SetHidden(string path, bool isHidden) |
| | | 402 | | { |
| | 0 | 403 | | if (!OperatingSystem.IsWindows()) |
| | | 404 | | { |
| | 0 | 405 | | return; |
| | | 406 | | } |
| | | 407 | | |
| | 0 | 408 | | var info = new FileInfo(path); |
| | | 409 | | |
| | 0 | 410 | | if (info.Exists && |
| | 0 | 411 | | (info.Attributes & FileAttributes.Hidden) == FileAttributes.Hidden != isHidden) |
| | | 412 | | { |
| | 0 | 413 | | if (isHidden) |
| | | 414 | | { |
| | 0 | 415 | | File.SetAttributes(path, info.Attributes | FileAttributes.Hidden); |
| | | 416 | | } |
| | | 417 | | else |
| | | 418 | | { |
| | 0 | 419 | | File.SetAttributes(path, info.Attributes & ~FileAttributes.Hidden); |
| | | 420 | | } |
| | | 421 | | } |
| | 0 | 422 | | } |
| | | 423 | | |
| | | 424 | | /// <inheritdoc /> |
| | | 425 | | public virtual void SetAttributes(string path, bool isHidden, bool readOnly) |
| | | 426 | | { |
| | 0 | 427 | | if (!OperatingSystem.IsWindows()) |
| | | 428 | | { |
| | 0 | 429 | | return; |
| | | 430 | | } |
| | | 431 | | |
| | 0 | 432 | | var info = new FileInfo(path); |
| | | 433 | | |
| | 0 | 434 | | if (!info.Exists) |
| | | 435 | | { |
| | 0 | 436 | | return; |
| | | 437 | | } |
| | | 438 | | |
| | 0 | 439 | | if ((info.Attributes & FileAttributes.ReadOnly) == FileAttributes.ReadOnly == readOnly |
| | 0 | 440 | | && (info.Attributes & FileAttributes.Hidden) == FileAttributes.Hidden == isHidden) |
| | | 441 | | { |
| | 0 | 442 | | return; |
| | | 443 | | } |
| | | 444 | | |
| | 0 | 445 | | var attributes = info.Attributes; |
| | | 446 | | |
| | 0 | 447 | | if (readOnly) |
| | | 448 | | { |
| | 0 | 449 | | attributes |= FileAttributes.ReadOnly; |
| | | 450 | | } |
| | | 451 | | else |
| | | 452 | | { |
| | 0 | 453 | | attributes &= ~FileAttributes.ReadOnly; |
| | | 454 | | } |
| | | 455 | | |
| | 0 | 456 | | if (isHidden) |
| | | 457 | | { |
| | 0 | 458 | | attributes |= FileAttributes.Hidden; |
| | | 459 | | } |
| | | 460 | | else |
| | | 461 | | { |
| | 0 | 462 | | attributes &= ~FileAttributes.Hidden; |
| | | 463 | | } |
| | | 464 | | |
| | 0 | 465 | | File.SetAttributes(path, attributes); |
| | 0 | 466 | | } |
| | | 467 | | |
| | | 468 | | /// <inheritdoc /> |
| | | 469 | | public virtual void SwapFiles(string file1, string file2) |
| | | 470 | | { |
| | 0 | 471 | | ArgumentException.ThrowIfNullOrEmpty(file1); |
| | 0 | 472 | | ArgumentException.ThrowIfNullOrEmpty(file2); |
| | | 473 | | |
| | 0 | 474 | | var temp1 = Path.Combine(_tempPath, Guid.NewGuid().ToString("N", CultureInfo.InvariantCulture)); |
| | | 475 | | |
| | | 476 | | // Copying over will fail against hidden files |
| | 0 | 477 | | SetHidden(file1, false); |
| | 0 | 478 | | SetHidden(file2, false); |
| | | 479 | | |
| | 0 | 480 | | Directory.CreateDirectory(_tempPath); |
| | 0 | 481 | | File.Copy(file1, temp1, true); |
| | | 482 | | |
| | 0 | 483 | | File.Copy(file2, file1, true); |
| | 0 | 484 | | File.Move(temp1, file2, true); |
| | 0 | 485 | | } |
| | | 486 | | |
| | | 487 | | /// <inheritdoc /> |
| | | 488 | | public virtual bool ContainsSubPath(string parentPath, string path) |
| | | 489 | | { |
| | 1 | 490 | | ArgumentException.ThrowIfNullOrEmpty(parentPath); |
| | 1 | 491 | | ArgumentException.ThrowIfNullOrEmpty(path); |
| | | 492 | | |
| | 1 | 493 | | return path.Contains( |
| | 1 | 494 | | Path.TrimEndingDirectorySeparator(parentPath) + Path.DirectorySeparatorChar, |
| | 1 | 495 | | _isEnvironmentCaseInsensitive ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal); |
| | | 496 | | } |
| | | 497 | | |
| | | 498 | | /// <inheritdoc /> |
| | | 499 | | public virtual bool AreEqual(string path1, string path2) |
| | | 500 | | { |
| | 174 | 501 | | return Path.TrimEndingDirectorySeparator(path1).Equals( |
| | 174 | 502 | | Path.TrimEndingDirectorySeparator(path2), |
| | 174 | 503 | | _isEnvironmentCaseInsensitive ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal); |
| | | 504 | | } |
| | | 505 | | |
| | | 506 | | /// <inheritdoc /> |
| | | 507 | | public virtual string GetFileNameWithoutExtension(FileSystemMetadata info) |
| | | 508 | | { |
| | 0 | 509 | | if (info.IsDirectory) |
| | | 510 | | { |
| | 0 | 511 | | return info.Name; |
| | | 512 | | } |
| | | 513 | | |
| | 0 | 514 | | return Path.GetFileNameWithoutExtension(info.FullName); |
| | | 515 | | } |
| | | 516 | | |
| | | 517 | | /// <inheritdoc /> |
| | | 518 | | public virtual bool IsPathFile(string path) |
| | | 519 | | { |
| | 1997 | 520 | | if (path.Contains("://", StringComparison.OrdinalIgnoreCase) |
| | 1997 | 521 | | && !path.StartsWith("file://", StringComparison.OrdinalIgnoreCase)) |
| | | 522 | | { |
| | 0 | 523 | | return false; |
| | | 524 | | } |
| | | 525 | | |
| | 1997 | 526 | | return true; |
| | | 527 | | } |
| | | 528 | | |
| | | 529 | | /// <inheritdoc /> |
| | | 530 | | public virtual void DeleteFile(string path) |
| | | 531 | | { |
| | 0 | 532 | | SetAttributes(path, false, false); |
| | 0 | 533 | | File.Delete(path); |
| | 0 | 534 | | } |
| | | 535 | | |
| | | 536 | | /// <inheritdoc /> |
| | | 537 | | public virtual IEnumerable<FileSystemMetadata> GetDrives() |
| | | 538 | | { |
| | | 539 | | // check for ready state to avoid waiting for drives to timeout |
| | | 540 | | // some drives on linux have no actual size or are used for other purposes |
| | 0 | 541 | | return DriveInfo.GetDrives() |
| | 0 | 542 | | .Where( |
| | 0 | 543 | | d => (d.DriveType == DriveType.Fixed || d.DriveType == DriveType.Network || d.DriveType == DriveType |
| | 0 | 544 | | && d.IsReady |
| | 0 | 545 | | && d.TotalSize != 0) |
| | 0 | 546 | | .Select(d => new FileSystemMetadata |
| | 0 | 547 | | { |
| | 0 | 548 | | Name = d.Name, |
| | 0 | 549 | | FullName = d.RootDirectory.FullName, |
| | 0 | 550 | | IsDirectory = true |
| | 0 | 551 | | }); |
| | | 552 | | } |
| | | 553 | | |
| | | 554 | | /// <inheritdoc /> |
| | | 555 | | public virtual IEnumerable<FileSystemMetadata> GetDirectories(string path, bool recursive = false) |
| | | 556 | | { |
| | 0 | 557 | | return ToMetadata(new DirectoryInfo(path).EnumerateDirectories("*", GetEnumerationOptions(recursive))); |
| | | 558 | | } |
| | | 559 | | |
| | | 560 | | /// <inheritdoc /> |
| | | 561 | | public virtual IEnumerable<FileSystemMetadata> GetFiles(string path, bool recursive = false) |
| | | 562 | | { |
| | 1 | 563 | | return GetFiles(path, "*", recursive); |
| | | 564 | | } |
| | | 565 | | |
| | | 566 | | /// <inheritdoc /> |
| | | 567 | | public virtual IEnumerable<FileSystemMetadata> GetFiles(string path, string searchPattern, bool recursive = fals |
| | | 568 | | { |
| | 1 | 569 | | return GetFiles(path, searchPattern, null, false, recursive); |
| | | 570 | | } |
| | | 571 | | |
| | | 572 | | /// <inheritdoc /> |
| | | 573 | | public virtual IEnumerable<FileSystemMetadata> GetFiles(string path, IReadOnlyList<string>? extensions, bool ena |
| | | 574 | | { |
| | 13 | 575 | | return GetFiles(path, "*", extensions, enableCaseSensitiveExtensions, recursive); |
| | | 576 | | } |
| | | 577 | | |
| | | 578 | | /// <inheritdoc /> |
| | | 579 | | public virtual IEnumerable<FileSystemMetadata> GetFiles(string path, string searchPattern, IReadOnlyList<string> |
| | | 580 | | { |
| | 14 | 581 | | var enumerationOptions = GetEnumerationOptions(recursive); |
| | | 582 | | |
| | | 583 | | // On linux and macOS the search pattern is case-sensitive |
| | | 584 | | // If we're OK with case-sensitivity, and we're only filtering for one extension, then use the native method |
| | 14 | 585 | | if ((enableCaseSensitiveExtensions || _isEnvironmentCaseInsensitive) && extensions is not null && extensions |
| | | 586 | | { |
| | 0 | 587 | | searchPattern = searchPattern.EndsWith(extensions[0], StringComparison.Ordinal) ? searchPattern : search |
| | | 588 | | |
| | 0 | 589 | | return ToMetadata(new DirectoryInfo(path).EnumerateFiles(searchPattern, enumerationOptions)); |
| | | 590 | | } |
| | | 591 | | |
| | 14 | 592 | | var files = new DirectoryInfo(path).EnumerateFiles(searchPattern, enumerationOptions); |
| | | 593 | | |
| | 14 | 594 | | if (extensions is not null && extensions.Count > 0) |
| | | 595 | | { |
| | 13 | 596 | | files = files.Where(i => |
| | 13 | 597 | | { |
| | 13 | 598 | | var ext = i.Extension.AsSpan(); |
| | 13 | 599 | | if (ext.IsEmpty) |
| | 13 | 600 | | { |
| | 13 | 601 | | return false; |
| | 13 | 602 | | } |
| | 13 | 603 | | |
| | 13 | 604 | | return extensions.Contains(ext, StringComparison.OrdinalIgnoreCase); |
| | 13 | 605 | | }); |
| | | 606 | | } |
| | | 607 | | |
| | 14 | 608 | | return ToMetadata(files); |
| | | 609 | | } |
| | | 610 | | |
| | | 611 | | /// <inheritdoc /> |
| | | 612 | | public virtual IEnumerable<FileSystemMetadata> GetFileSystemEntries(string path, bool recursive = false) |
| | | 613 | | { |
| | | 614 | | // Note: any of unhandled exceptions thrown by this method may cause the caller to believe the whole path is |
| | | 615 | | // But what causing the exception may be a single file under that path. This could lead to unexpected behavi |
| | | 616 | | // For example, the scanner will remove everything in that path due to unhandled errors. |
| | 253 | 617 | | var directoryInfo = new DirectoryInfo(path); |
| | 253 | 618 | | var enumerationOptions = GetEnumerationOptions(recursive); |
| | | 619 | | |
| | 253 | 620 | | return ToMetadata(directoryInfo.EnumerateFileSystemInfos("*", enumerationOptions)); |
| | | 621 | | } |
| | | 622 | | |
| | | 623 | | private IEnumerable<FileSystemMetadata> ToMetadata(IEnumerable<FileSystemInfo> infos) |
| | | 624 | | { |
| | 267 | 625 | | return infos.Select(GetFileSystemMetadata); |
| | | 626 | | } |
| | | 627 | | |
| | | 628 | | /// <inheritdoc /> |
| | | 629 | | public virtual IEnumerable<string> GetDirectoryPaths(string path, bool recursive = false) |
| | | 630 | | { |
| | 25 | 631 | | return Directory.EnumerateDirectories(path, "*", GetEnumerationOptions(recursive)); |
| | | 632 | | } |
| | | 633 | | |
| | | 634 | | /// <inheritdoc /> |
| | | 635 | | public virtual IEnumerable<string> GetFilePaths(string path, bool recursive = false) |
| | | 636 | | { |
| | 3 | 637 | | return GetFilePaths(path, null, false, recursive); |
| | | 638 | | } |
| | | 639 | | |
| | | 640 | | /// <inheritdoc /> |
| | | 641 | | public virtual IEnumerable<string> GetFilePaths(string path, string[]? extensions, bool enableCaseSensitiveExten |
| | | 642 | | { |
| | 4 | 643 | | var enumerationOptions = GetEnumerationOptions(recursive); |
| | | 644 | | |
| | | 645 | | // On linux and macOS the search pattern is case-sensitive |
| | | 646 | | // If we're OK with case-sensitivity, and we're only filtering for one extension, then use the native method |
| | 4 | 647 | | if ((enableCaseSensitiveExtensions || _isEnvironmentCaseInsensitive) && extensions is not null && extensions |
| | | 648 | | { |
| | 1 | 649 | | return Directory.EnumerateFiles(path, "*" + extensions[0], enumerationOptions); |
| | | 650 | | } |
| | | 651 | | |
| | 3 | 652 | | var files = Directory.EnumerateFiles(path, "*", enumerationOptions); |
| | | 653 | | |
| | 3 | 654 | | if (extensions is not null && extensions.Length > 0) |
| | | 655 | | { |
| | 0 | 656 | | files = files.Where(i => |
| | 0 | 657 | | { |
| | 0 | 658 | | var ext = Path.GetExtension(i.AsSpan()); |
| | 0 | 659 | | if (ext.IsEmpty) |
| | 0 | 660 | | { |
| | 0 | 661 | | return false; |
| | 0 | 662 | | } |
| | 0 | 663 | | |
| | 0 | 664 | | return extensions.Contains(ext, StringComparison.OrdinalIgnoreCase); |
| | 0 | 665 | | }); |
| | | 666 | | } |
| | | 667 | | |
| | 3 | 668 | | return files; |
| | | 669 | | } |
| | | 670 | | |
| | | 671 | | /// <inheritdoc /> |
| | | 672 | | public virtual IEnumerable<string> GetFileSystemEntryPaths(string path, bool recursive = false) |
| | | 673 | | { |
| | | 674 | | try |
| | | 675 | | { |
| | 27 | 676 | | return Directory.EnumerateFileSystemEntries(path, "*", GetEnumerationOptions(recursive)); |
| | | 677 | | } |
| | 0 | 678 | | catch (Exception ex) when (ex is UnauthorizedAccessException or DirectoryNotFoundException or SecurityExcept |
| | | 679 | | { |
| | 0 | 680 | | _logger.LogError(ex, "Failed to enumerate path {Path}", path); |
| | 0 | 681 | | return Enumerable.Empty<string>(); |
| | | 682 | | } |
| | 27 | 683 | | } |
| | | 684 | | |
| | | 685 | | /// <inheritdoc /> |
| | | 686 | | public virtual bool DirectoryExists(string path) |
| | | 687 | | { |
| | 0 | 688 | | return Directory.Exists(path); |
| | | 689 | | } |
| | | 690 | | |
| | | 691 | | /// <inheritdoc /> |
| | | 692 | | public virtual bool FileExists(string path) |
| | | 693 | | { |
| | 0 | 694 | | return File.Exists(path); |
| | | 695 | | } |
| | | 696 | | |
| | | 697 | | private EnumerationOptions GetEnumerationOptions(bool recursive) |
| | | 698 | | { |
| | 323 | 699 | | return new EnumerationOptions |
| | 323 | 700 | | { |
| | 323 | 701 | | RecurseSubdirectories = recursive, |
| | 323 | 702 | | IgnoreInaccessible = true, |
| | 323 | 703 | | // Don't skip any files. |
| | 323 | 704 | | AttributesToSkip = 0 |
| | 323 | 705 | | }; |
| | | 706 | | } |
| | | 707 | | } |
| | | 708 | | } |