// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. #nullable disable using System; using System.IO; using System.Linq; using System.Threading; using osu.Framework.Platform; namespace osu.Game.IO { /// /// A that is migratable to different locations. /// public abstract class MigratableStorage : WrappedStorage { /// /// A relative list of directory paths which should not be migrated. /// public virtual string[] IgnoreDirectories => Array.Empty(); /// /// A relative list of file paths which should not be migrated. /// public virtual string[] IgnoreFiles => Array.Empty(); /// /// A list of file/directory suffixes which should not be migrated. /// public virtual string[] IgnoreSuffixes => Array.Empty(); protected MigratableStorage(Storage storage, string subPath = null) : base(storage, subPath) { } /// /// A general purpose migration method to move the storage to a different location. /// The target storage of the migration. /// /// Whether cleanup could complete. public virtual bool Migrate(Storage newStorage) { var source = new DirectoryInfo(GetFullPath(".")); var destination = new DirectoryInfo(newStorage.GetFullPath(".")); // using Uri is the easiest way to check equality and contains (https://stackoverflow.com/a/7710620) var sourceUri = new Uri(source.FullName + Path.DirectorySeparatorChar); var destinationUri = new Uri(destination.FullName + Path.DirectorySeparatorChar); if (sourceUri == destinationUri) throw new ArgumentException("Destination provided is already the current location", destination.FullName); if (sourceUri.IsBaseOf(destinationUri)) throw new ArgumentException("Destination provided is inside the source", destination.FullName); // ensure the new location has no files present, else hard abort if (destination.Exists) { if (destination.GetFiles().Length > 0 || destination.GetDirectories().Length > 0) throw new ArgumentException("Destination provided already has files or directories present", destination.FullName); } CopyRecursive(source, destination); ChangeTargetStorage(newStorage); return DeleteRecursive(source); } protected bool DeleteRecursive(DirectoryInfo target, bool topLevelExcludes = true) { bool allFilesDeleted = true; foreach (System.IO.FileInfo fi in target.GetFiles()) { if (topLevelExcludes && IgnoreFiles.Contains(fi.Name)) continue; if (IgnoreSuffixes.Any(suffix => fi.Name.EndsWith(suffix, StringComparison.Ordinal))) continue; allFilesDeleted &= AttemptOperation(() => fi.Delete(), throwOnFailure: false); } foreach (DirectoryInfo dir in target.GetDirectories()) { if (topLevelExcludes && IgnoreDirectories.Contains(dir.Name)) continue; if (IgnoreSuffixes.Any(suffix => dir.Name.EndsWith(suffix, StringComparison.Ordinal))) continue; allFilesDeleted &= AttemptOperation(() => dir.Delete(true), throwOnFailure: false); } if (target.GetFiles().Length == 0 && target.GetDirectories().Length == 0) allFilesDeleted &= AttemptOperation(target.Delete, throwOnFailure: false); return allFilesDeleted; } protected void CopyRecursive(DirectoryInfo source, DirectoryInfo destination, bool topLevelExcludes = true) { // based off example code https://docs.microsoft.com/en-us/dotnet/api/system.io.directoryinfo if (!destination.Exists) Directory.CreateDirectory(destination.FullName); foreach (System.IO.FileInfo fileInfo in source.GetFiles()) { if (topLevelExcludes && IgnoreFiles.Contains(fileInfo.Name)) continue; if (IgnoreSuffixes.Any(suffix => fileInfo.Name.EndsWith(suffix, StringComparison.Ordinal))) continue; AttemptOperation(() => { fileInfo.Refresh(); // A temporary file may have been deleted since the initial GetFiles operation. // We don't want the whole migration process to fail in such a case. if (!fileInfo.Exists) return; fileInfo.CopyTo(Path.Combine(destination.FullName, fileInfo.Name), true); }); } foreach (DirectoryInfo dir in source.GetDirectories()) { if (topLevelExcludes && IgnoreDirectories.Contains(dir.Name)) continue; if (IgnoreSuffixes.Any(suffix => dir.Name.EndsWith(suffix, StringComparison.Ordinal))) continue; CopyRecursive(dir, destination.CreateSubdirectory(dir.Name), false); } } /// /// Attempt an IO operation multiple times and only throw if none of the attempts succeed. /// /// The action to perform. /// The number of attempts (250ms wait between each). /// Whether to throw an exception on failure. If false, will silently fail. protected static bool AttemptOperation(Action action, int attempts = 10, bool throwOnFailure = true) { while (true) { try { action(); return true; } catch (Exception) { if (attempts-- == 0) { if (throwOnFailure) throw; return false; } } Thread.Sleep(250); } } } }