Skip to content

Trees: Prevent file system trees showing other file types that aren't supported for editing #20567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 22, 2025
Merged

Trees: Prevent file system trees showing other file types that aren't supported for editing #20567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3c4551b
Added check to only find .css files in FileSystemTreeServiceBase.cs
NillasKA Oct 20, 2025
7a16320
Marking GetFiles as virtual and overriding it in StyleSheetTreeServic…
NillasKA Oct 20, 2025
e66bf17
Redone tests to fit new format
NillasKA Oct 20, 2025
b40a2ab
Fix tests to use file extensions
NillasKA Oct 22, 2025
ba9eb7b
Adding file extensions to all other relevant tests
NillasKA Oct 22, 2025
24aca97
Adding file filter to remaining trees
NillasKA Oct 22, 2025
e8dca51
Adding tests to ensure invalid filetypes wont show
NillasKA Oct 22, 2025
4ba033d
Merge branch 'main' into v16/bugfix/show-only-css-files-in-stylesheet…
NillasKA Oct 22, 2025
840c090
Encapulation and resolved minor warnings in tests.
AndyButland Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Umbraco.Cms.Api.Management/Services/FileSystem/FileSystemTreeServiceBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,12 @@ public string[] GetDirectories(string path) => FileSystem

public string[] GetFiles(string path) => FileSystem
.GetFiles(path)
.Where(FilterFile)
.OrderBy(file => file)
.ToArray();

protected virtual bool FilterFile(string file) => true;

public bool DirectoryHasChildren(string path)
=> FileSystem.GetFiles(path).Any() || FileSystem.GetDirectories(path).Any();

Expand Down
2 changes: 2 additions & 0 deletions src/Umbraco.Cms.Api.Management/Services/FileSystem/PartialViewTreeService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ public class PartialViewTreeService : FileSystemTreeServiceBase, IPartialViewTre
public PartialViewTreeService(FileSystems fileSystems) =>
_partialViewFileSystem = fileSystems.PartialViewsFileSystem ??
throw new ArgumentException("Missing partial views file system", nameof(fileSystems));

protected override bool FilterFile(string file) => file.ToLowerInvariant().EndsWith(".cshtml");
}
2 changes: 2 additions & 0 deletions src/Umbraco.Cms.Api.Management/Services/FileSystem/ScriptTreeService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ public class ScriptTreeService : FileSystemTreeServiceBase, IScriptTreeService
public ScriptTreeService(FileSystems fileSystems) =>
_scriptFileSystem = fileSystems.ScriptsFileSystem ??
throw new ArgumentException("Missing partial views file system", nameof(fileSystems));

protected override bool FilterFile(string file) => file.ToLowerInvariant().EndsWith(".js");
}
4 changes: 3 additions & 1 deletion src/Umbraco.Cms.Api.Management/Services/FileSystem/StyleSheetTreeService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@ public class StyleSheetTreeService : FileSystemTreeServiceBase, IStyleSheetTreeS

public StyleSheetTreeService(FileSystems fileSystems) =>
_scriptFileSystem = fileSystems.StylesheetsFileSystem ??
throw new ArgumentException("Missing partial views file system", nameof(fileSystems));
throw new ArgumentException("Missing stylesheets file system", nameof(fileSystems));

protected override bool FilterFile(string file) => file.ToLowerInvariant().EndsWith(".css");
}
10 changes: 6 additions & 4 deletions .../Umbraco.Tests.Integration/ManagementApi/Services/Trees/FileSystemTreeServiceTestsBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@ public abstract class FileSystemTreeServiceTestsBase : UmbracoIntegrationTest

protected IFileSystem TestFileSystem { get; private set; }

protected abstract string FileExtension { get; set; }

protected abstract string FileSystemPath { get; }

protected IHostingEnvironment HostingEnvironment => GetRequiredService<IHostingEnvironment>();

[SetUp]
public void SetUpFileSystem()
public virtual void SetUpFileSystem()
{
TestFileSystem = new PhysicalFileSystem(IOHelper, HostingEnvironment, LoggerFactory.CreateLogger<PhysicalFileSystem>(), HostingEnvironment.MapPathWebRoot(FileSystemPath), HostingEnvironment.ToAbsolute(FileSystemPath));

Expand All @@ -37,11 +39,11 @@ public void SetUpFileSystem()
for (int i = 0; i < 10; i++)
{
using var stream = CreateStream(Path.Join("tests"));
TestFileSystem.AddFile($"file{i}", stream);
TestFileSystem.AddFile($"file{i}{FileExtension}", stream);
}
}

private static Stream CreateStream(string contents = null)
protected static Stream CreateStream(string contents = null)
{
if (string.IsNullOrEmpty(contents))
{
Expand All @@ -59,7 +61,7 @@ private static Stream CreateStream(string contents = null)
protected virtual IFileSystem? GetScriptsFileSystem() => null;

[TearDown]
public void TearDownFileSystem()
public virtual void TearDownFileSystem()
{
Purge(TestFileSystem, string.Empty);
FileSystems = null;
Expand Down
32 changes: 25 additions & 7 deletions tests/Umbraco.Tests.Integration/ManagementApi/Services/Trees/PartialViewTreeServiceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ namespace Umbraco.Cms.Tests.Integration.ManagementApi.Services.Trees;

public class PartialViewTreeServiceTests : FileSystemTreeServiceTestsBase
{
protected override string FileExtension { get; set; } = ".cshtml";

protected override string FileSystemPath => Constants.SystemDirectories.PartialViews;

protected override IFileSystem? GetPartialViewsFileSystem() => TestFileSystem;
Expand All @@ -17,12 +19,12 @@ public void Can_Get_Siblings_From_PartialView_Tree_Service()
{
var service = new PartialViewTreeService(FileSystems);

FileSystemTreeItemPresentationModel[] treeModel = service.GetSiblingsViewModels("file5", 1, 1, out long before, out var after);
int index = Array.FindIndex(treeModel, item => item.Name == "file5");
FileSystemTreeItemPresentationModel[] treeModel = service.GetSiblingsViewModels($"file5{FileExtension}", 1, 1, out long before, out var after);
int index = Array.FindIndex(treeModel, item => item.Name == $"file5{FileExtension}");

Assert.AreEqual(treeModel[index].Name, "file5");
Assert.AreEqual(treeModel[index - 1].Name, "file4");
Assert.AreEqual(treeModel[index + 1].Name, "file6");
Assert.AreEqual(treeModel[index].Name, $"file5{FileExtension}");
Assert.AreEqual(treeModel[index - 1].Name, $"file4{FileExtension}");
Assert.AreEqual(treeModel[index + 1].Name, $"file6{FileExtension}");
Assert.That(treeModel.Length == 3);
Assert.AreEqual(after, 3);
Assert.AreEqual(before, 4);
Expand All @@ -33,7 +35,7 @@ public void Can_Get_Ancestors_From_StyleSheet_Tree_Service()
{
var service = new PartialViewTreeService(FileSystems);

var path = Path.Join("tests", "file5");
var path = Path.Join("tests", $"file5{FileExtension}");
FileSystemTreeItemPresentationModel[] treeModel = service.GetAncestorModels(path, true);

Assert.IsNotEmpty(treeModel);
Expand All @@ -46,9 +48,25 @@ public void Can_Get_PathViewModels_From_StyleSheet_Tree_Service()
{
var service = new PartialViewTreeService(FileSystems);

FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, Int32.MaxValue, out var totalItems);
FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, int.MaxValue, out var totalItems);

Assert.IsNotEmpty(treeModels);
Assert.AreEqual(treeModels.Length, totalItems);
}

[Test]
public void Will_Hide_Unsupported_File_Extensions()
{
var service = new PartialViewTreeService(FileSystems);
for (int i = 0; i < 2; i++)
{
using var stream = CreateStream(Path.Join("tests"));
TestFileSystem.AddFile($"file{i}.invalid", stream);
}

FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, int.MaxValue, out var totalItems);

Assert.IsEmpty(treeModels.Where(file => file.Name.Contains(".invalid")));
Assert.AreEqual(treeModels.Length, totalItems);
}
}
31 changes: 24 additions & 7 deletions tests/Umbraco.Tests.Integration/ManagementApi/Services/Trees/ScriptTreeServiceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ namespace Umbraco.Cms.Tests.Integration.ManagementApi.Services.Trees;

public class ScriptTreeServiceTests : FileSystemTreeServiceTestsBase
{
protected override string FileExtension { get; set; } = ".js";
protected override string FileSystemPath => GlobalSettings.UmbracoScriptsPath;

protected override IFileSystem? GetScriptsFileSystem() => TestFileSystem;
Expand All @@ -16,12 +17,12 @@ public void Can_Get_Siblings_From_Script_Tree_Service()
{
var service = new ScriptTreeService(FileSystems);

FileSystemTreeItemPresentationModel[] treeModel = service.GetSiblingsViewModels("file5", 1, 1, out long before, out var after);
int index = Array.FindIndex(treeModel, item => item.Name == "file5");
FileSystemTreeItemPresentationModel[] treeModel = service.GetSiblingsViewModels($"file5{FileExtension}", 1, 1, out long before, out var after);
int index = Array.FindIndex(treeModel, item => item.Name == $"file5{FileExtension}");

Assert.AreEqual(treeModel[index].Name, "file5");
Assert.AreEqual(treeModel[index - 1].Name, "file4");
Assert.AreEqual(treeModel[index + 1].Name, "file6");
Assert.AreEqual(treeModel[index].Name, $"file5{FileExtension}");
Assert.AreEqual(treeModel[index - 1].Name, $"file4{FileExtension}");
Assert.AreEqual(treeModel[index + 1].Name, $"file6{FileExtension}");
Assert.That(treeModel.Length == 3);
Assert.AreEqual(after, 3);
Assert.AreEqual(before, 4);
Expand All @@ -32,7 +33,7 @@ public void Can_Get_Ancestors_From_StyleSheet_Tree_Service()
{
var service = new ScriptTreeService(FileSystems);

var path = Path.Join("tests", "file5");
var path = Path.Join("tests", $"file5{FileExtension}");
FileSystemTreeItemPresentationModel[] treeModel = service.GetAncestorModels(path, true);

Assert.IsNotEmpty(treeModel);
Expand All @@ -45,9 +46,25 @@ public void Can_Get_PathViewModels_From_StyleSheet_Tree_Service()
{
var service = new ScriptTreeService(FileSystems);

FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, Int32.MaxValue, out var totalItems);
FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, int.MaxValue, out var totalItems);

Assert.IsNotEmpty(treeModels);
Assert.AreEqual(treeModels.Length, totalItems);
}

[Test]
public void Will_Hide_Unsupported_File_Extensions()
{
var service = new ScriptTreeService(FileSystems);
for (int i = 0; i < 2; i++)
{
using var stream = CreateStream(Path.Join("tests"));
TestFileSystem.AddFile($"file{i}.invalid", stream);
}

FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, int.MaxValue, out var totalItems);

Assert.IsEmpty(treeModels.Where(file => file.Name.Contains(".invalid")));
Assert.AreEqual(treeModels.Length, totalItems);
}
}
32 changes: 25 additions & 7 deletions tests/Umbraco.Tests.Integration/ManagementApi/Services/Trees/StyleSheetTreeServiceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ namespace Umbraco.Cms.Tests.Integration.ManagementApi.Services.Trees;

public class StyleSheetTreeServiceTests : FileSystemTreeServiceTestsBase
{
protected override string FileExtension { get; set; } = ".css";

protected override string FileSystemPath => GlobalSettings.UmbracoCssPath;

protected override IFileSystem? GetStylesheetsFileSystem() => TestFileSystem;
Expand All @@ -16,12 +18,12 @@ public void Can_Get_Siblings_From_StyleSheet_Tree_Service()
{
var service = new StyleSheetTreeService(FileSystems);

FileSystemTreeItemPresentationModel[] treeModel = service.GetSiblingsViewModels("file5", 1, 1, out long before, out var after);
int index = Array.FindIndex(treeModel, item => item.Name == "file5");
FileSystemTreeItemPresentationModel[] treeModel = service.GetSiblingsViewModels($"file5{FileExtension}", 1, 1, out long before, out var after);
int index = Array.FindIndex(treeModel, item => item.Name == $"file5{FileExtension}");

Assert.AreEqual(treeModel[index].Name, "file5");
Assert.AreEqual(treeModel[index - 1].Name, "file4");
Assert.AreEqual(treeModel[index + 1].Name, "file6");
Assert.AreEqual(treeModel[index].Name, $"file5{FileExtension}");
Assert.AreEqual(treeModel[index - 1].Name, $"file4{FileExtension}");
Assert.AreEqual(treeModel[index + 1].Name, $"file6{FileExtension}");
Assert.That(treeModel.Length == 3);
Assert.AreEqual(after, 3);
Assert.AreEqual(before, 4);
Expand All @@ -32,7 +34,7 @@ public void Can_Get_Ancestors_From_StyleSheet_Tree_Service()
{
var service = new StyleSheetTreeService(FileSystems);

var path = Path.Join("tests", "file5");
var path = Path.Join("tests", $"file5{FileExtension}");
FileSystemTreeItemPresentationModel[] treeModel = service.GetAncestorModels(path, true);

Assert.IsNotEmpty(treeModel);
Expand All @@ -45,9 +47,25 @@ public void Can_Get_PathViewModels_From_StyleSheet_Tree_Service()
{
var service = new StyleSheetTreeService(FileSystems);

FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, Int32.MaxValue, out var totalItems);
FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, int.MaxValue, out var totalItems);

Assert.IsNotEmpty(treeModels);
Assert.AreEqual(treeModels.Length, totalItems);
}

[Test]
public void Will_Hide_Unsupported_File_Extensions()
{
var service = new StyleSheetTreeService(FileSystems);
for (int i = 0; i < 2; i++)
{
using var stream = CreateStream(Path.Join("tests"));
TestFileSystem.AddFile($"file{i}.invalid", stream);
}

FileSystemTreeItemPresentationModel[] treeModels = service.GetPathViewModels(string.Empty, 0, int.MaxValue, out var totalItems);

Assert.IsEmpty(treeModels.Where(file => file.Name.Contains(".invalid")));
Assert.AreEqual(treeModels.Length, totalItems);
}
}
Loading