Code Quality: Implemented OwlCore.Storage (#16900)

Co-authored-by: d2dyno006 <53011783+d2dyno006@users.noreply.github.com>

Author: d2dyno1

Directory.Packages.props

@@ -29,6 +29,7 @@
  <PackageVersion Include="Microsoft.Extensions.Logging" Version="9.0.2" />
  <PackageVersion Include="Microsoft.Windows.SDK.BuildTools" Version="10.0.26100.1742" />
  <PackageVersion Include="Microsoft.Xaml.Behaviors.WinUI.Managed" Version="3.0.0" />
+ <PackageVersion Include="OwlCore.Storage" Version="0.12.2" />
  <PackageVersion Include="Sentry" Version="5.1.1" />
  <PackageVersion Include="SevenZipSharp" Version="1.0.2" />
  <PackageVersion Include="SQLitePCLRaw.bundle_green" Version="2.1.10" />

src/Files.App.Storage/GlobalUsings.cs

@@ -23,7 +23,7 @@
 global using global::Files.Core.Storage.Enums;
 global using global::Files.Core.Storage.EventArguments;
 global using global::Files.Core.Storage.Extensions;
-global using global::Files.Core.Storage.StorageEnumeration;
+global using global::OwlCore.Storage;
 
 // Files.App.Storage
 

src/Files.App.Storage/Storables/FtpStorage/FtpStorable.cs

@@ -5,11 +5,8 @@
 
 namespace Files.App.Storage.Storables
 {
-public abstract class FtpStorable : ILocatableStorable, INestedStorable
+public abstract class FtpStorable : IStorableChild
 {
-/// <inheritdoc/>
-public virtual string Path { get; protected set; }
-
 /// <inheritdoc/>
 public virtual string Name { get; protected set; }
 
@@ -23,21 +20,20 @@ public abstract class FtpStorable : ILocatableStorable, INestedStorable
 
 protected internal FtpStorable(string path, string name, IFolder? parent)
 {
-Path = FtpHelpers.GetFtpPath(path);
+Id = FtpHelpers.GetFtpPath(path);
 Name = name;
-Id = Path;
 Parent = parent;
 }
 
 /// <inheritdoc/>
 public Task<IFolder?> GetParentAsync(CancellationToken cancellationToken = default)
 {
-return Task.FromResult<IFolder?>(Parent);
+return Task.FromResult(Parent);
 }
 
 protected AsyncFtpClient GetFtpClient()
 {
-return FtpHelpers.GetFtpClient(Path);
+return FtpHelpers.GetFtpClient(Id);
 }
 }
 }

src/Files.App.Storage/Storables/FtpStorage/FtpStorageFile.cs

@@ -5,7 +5,7 @@
 
 namespace Files.App.Storage.Storables
 {
-public sealed class FtpStorageFile : FtpStorable, IModifiableFile, ILocatableFile, INestedFile
+public sealed class FtpStorageFile : FtpStorable, IChildFile
 {
 public FtpStorageFile(string path, string name, IFolder? parent)
 : base(path, name, parent)
@@ -19,9 +19,9 @@ public async Task<Stream> OpenStreamAsync(FileAccess access, CancellationToken c
 await ftpClient.EnsureConnectedAsync(cancellationToken);
 
 if (access.HasFlag(FileAccess.Write))
-return await ftpClient.OpenWrite(Path, token: cancellationToken);
+return await ftpClient.OpenWrite(Id, token: cancellationToken);
 else if (access.HasFlag(FileAccess.Read))
-return await ftpClient.OpenRead(Path, token: cancellationToken);
+return await ftpClient.OpenRead(Id, token: cancellationToken);
 else
 throw new ArgumentException($"Invalid {nameof(access)} flag.");
 }

src/Files.App.Storage/Storables/FtpStorage/FtpStorageFolder.cs

@@ -8,68 +8,57 @@
 
 namespace Files.App.Storage.Storables
 {
-public sealed class FtpStorageFolder : FtpStorable, ILocatableFolder, IModifiableFolder, IFolderExtended, INestedFolder, IDirectCopy, IDirectMove
+public sealed class FtpStorageFolder : FtpStorable, IModifiableFolder, IChildFolder, IDirectCopy, IDirectMove, IGetFirstByName
 {
 public FtpStorageFolder(string path, string name, IFolder? parent)
 : base(path, name, parent)
 {
 }
 
 /// <inheritdoc/>
-public async Task<INestedFile> GetFileAsync(string fileName, CancellationToken cancellationToken = default)
+public async Task<IStorableChild> GetFirstByNameAsync(string folderName, CancellationToken cancellationToken = default)
 {
 using var ftpClient = GetFtpClient();
 await ftpClient.EnsureConnectedAsync(cancellationToken);
 
-var path = FtpHelpers.GetFtpPath(PathHelpers.Combine(Path, fileName));
+var path = FtpHelpers.GetFtpPath(PathHelpers.Combine(Id, folderName));
 var item = await ftpClient.GetObjectInfo(path, token: cancellationToken);
 
-if (item is null || item.Type != FtpObjectType.File)
+if (item is null)
 throw new FileNotFoundException();
 
-return new FtpStorageFile(path, item.Name, this);
-}
-
-/// <inheritdoc/>
-public async Task<INestedFolder> GetFolderAsync(string folderName, CancellationToken cancellationToken = default)
-{
-using var ftpClient = GetFtpClient();
-await ftpClient.EnsureConnectedAsync(cancellationToken);
-
-var path = FtpHelpers.GetFtpPath(PathHelpers.Combine(Path, folderName));
-var item = await ftpClient.GetObjectInfo(path, token: cancellationToken);
-
-if (item is null || item.Type != FtpObjectType.Directory)
-throw new DirectoryNotFoundException();
+if (item.Type == FtpObjectType.Directory)
+return new FtpStorageFolder(path, item.Name, this);
+else
+return new FtpStorageFile(path, item.Name, this);
 
-return new FtpStorageFolder(path, item.Name, this);
 }
 
 /// <inheritdoc/>
-public async IAsyncEnumerable<INestedStorable> GetItemsAsync(StorableKind kind = StorableKind.All, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+public async IAsyncEnumerable<IStorableChild> GetItemsAsync(StorableType kind = StorableType.All, [EnumeratorCancellation] CancellationToken cancellationToken = default)
 {
 using var ftpClient = GetFtpClient();
 await ftpClient.EnsureConnectedAsync(cancellationToken);
 
-if (kind == StorableKind.Files)
+if (kind == StorableType.File)
 {
-foreach (var item in await ftpClient.GetListing(Path, cancellationToken))
+foreach (var item in await ftpClient.GetListing(Id, cancellationToken))
 {
 if (item.Type == FtpObjectType.File)
 yield return new FtpStorageFile(item.FullName, item.Name, this);
 }
 }
-else if (kind == StorableKind.Folders)
+else if (kind == StorableType.Folder)
 {
-foreach (var item in await ftpClient.GetListing(Path, cancellationToken))
+foreach (var item in await ftpClient.GetListing(Id, cancellationToken))
 {
 if (item.Type == FtpObjectType.Directory)
 yield return new FtpStorageFolder(item.FullName, item.Name, this);
 }
 }
 else
 {
-foreach (var item in await ftpClient.GetListing(Path, cancellationToken))
+foreach (var item in await ftpClient.GetListing(Id, cancellationToken))
 {
 if (item.Type == FtpObjectType.File)
 yield return new FtpStorageFile(item.FullName, item.Name, this);
@@ -81,18 +70,24 @@ public async IAsyncEnumerable<INestedStorable> GetItemsAsync(StorableKind kind =
 }
 
 /// <inheritdoc/>
-public async Task DeleteAsync(INestedStorable item, bool permanently = false, CancellationToken cancellationToken = default)
+public Task<IFolderWatcher> GetFolderWatcherAsync(CancellationToken cancellationToken = default)
+{
+return Task.FromException<IFolderWatcher>(new NotSupportedException());
+}
+
+/// <inheritdoc/>
+public async Task DeleteAsync(IStorableChild item, CancellationToken cancellationToken = default)
 {
 using var ftpClient = GetFtpClient();
 await ftpClient.EnsureConnectedAsync(cancellationToken);
 
-if (item is ILocatableFile locatableFile)
+if (item is IFile locatableFile)
 {
-await ftpClient.DeleteFile(locatableFile.Path, cancellationToken);
+await ftpClient.DeleteFile(locatableFile.Id, cancellationToken);
 }
-else if (item is ILocatableFolder locatableFolder)
+else if (item is IFolder locatableFolder)
 {
-await ftpClient.DeleteDirectory(locatableFolder.Path, cancellationToken);
+await ftpClient.DeleteDirectory(locatableFolder.Id, cancellationToken);
 }
 else
 {
@@ -101,7 +96,7 @@ public async Task DeleteAsync(INestedStorable item, bool permanently = false, Ca
 }
 
 /// <inheritdoc/>
-public async Task<INestedStorable> CreateCopyOfAsync(INestedStorable itemToCopy, bool overwrite = default, CancellationToken cancellationToken = default)
+public async Task<IStorableChild> CreateCopyOfAsync(IStorableChild itemToCopy, bool overwrite = default, CancellationToken cancellationToken = default)
 {
 if (itemToCopy is IFile sourceFile)
 {
@@ -117,24 +112,24 @@ public async Task<INestedStorable> CreateCopyOfAsync(INestedStorable itemToCopy,
 }
 
 /// <inheritdoc/>
-public async Task<INestedStorable> MoveFromAsync(INestedStorable itemToMove, IModifiableFolder source, bool overwrite = default, CancellationToken cancellationToken = default)
+public async Task<IStorableChild> MoveFromAsync(IStorableChild itemToMove, IModifiableFolder source, bool overwrite = default, CancellationToken cancellationToken = default)
 {
 using var ftpClient = GetFtpClient();
 await ftpClient.EnsureConnectedAsync(cancellationToken);
 
 var newItem = await CreateCopyOfAsync(itemToMove, overwrite, cancellationToken);
-await source.DeleteAsync(itemToMove, true, cancellationToken);
+await source.DeleteAsync(itemToMove, cancellationToken);
 
 return newItem;
 }
 
 /// <inheritdoc/>
-public async Task<INestedFile> CreateFileAsync(string desiredName, bool overwrite = default, CancellationToken cancellationToken = default)
+public async Task<IChildFile> CreateFileAsync(string desiredName, bool overwrite = default, CancellationToken cancellationToken = default)
 {
 using var ftpClient = GetFtpClient();
 await ftpClient.EnsureConnectedAsync(cancellationToken);
 
-var newPath = $"{Path}/{desiredName}";
+var newPath = $"{Id}/{desiredName}";
 if (overwrite && await ftpClient.FileExists(newPath, cancellationToken))
 throw new IOException("File already exists.");
 
@@ -159,12 +154,12 @@ public async Task<INestedFile> CreateFileAsync(string desiredName, bool overwrit
 }
 
 /// <inheritdoc/>
-public async Task<INestedFolder> CreateFolderAsync(string desiredName, bool overwrite = default, CancellationToken cancellationToken = default)
+public async Task<IChildFolder> CreateFolderAsync(string desiredName, bool overwrite = default, CancellationToken cancellationToken = default)
 {
 using var ftpClient = GetFtpClient();
 await ftpClient.EnsureConnectedAsync(cancellationToken);
 
-var newPath = $"{Path}/{desiredName}";
+var newPath = $"{Id}/{desiredName}";
 if (overwrite && await ftpClient.DirectoryExists(newPath, cancellationToken))
 throw new IOException("Directory already exists.");