yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

V10: fix build warnings in Web.BackOffice (#12479)

Browse Source 
* Run code cleanup

* Start manual run

* Finish dotnet format + manual cleanup

* Fix up after merge

* Fix substrings changed to [..]

Co-authored-by: Nikolaj Geisle <niko737@edu.ucl.dk>
Co-authored-by: Zeegaan <nge@umbraco.dk>
This commit is contained in:
Nikolaj Geisle
2022-06-20 08:37:17 +02:00
committed by GitHub
parent 7688c61621
commit e762fa91bc
234 changed files with 28037 additions and 27527 deletions
Download Patch File Download Diff File Expand all files Collapse all files

319
src/Umbraco.Web.BackOffice/Trees/FileSystemTreeController.cs
View File

@@ -1,6 +1,3 @@
using System;
using System.IO;
using System.Linq;
using System.Net;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
@@ -12,193 +9,201 @@ using Umbraco.Cms.Core.Models.Trees;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Core.Trees;
using Umbraco.Extensions;
using Constants = Umbraco.Cms.Core.Constants;
namespace Umbraco.Cms.Web.BackOffice.Trees
namespace Umbraco.Cms.Web.BackOffice.Trees;
public abstract class FileSystemTreeController : TreeController
{
public abstract class FileSystemTreeController : TreeController
protected FileSystemTreeController(
ILocalizedTextService localizedTextService,
UmbracoApiControllerTypeCollection umbracoApiControllerTypeCollection,
IMenuItemCollectionFactory menuItemCollectionFactory,
IEventAggregator eventAggregator
)
: base(localizedTextService, umbracoApiControllerTypeCollection, eventAggregator) =>
MenuItemCollectionFactory = menuItemCollectionFactory;
protected abstract IFileSystem? FileSystem { get; }
protected IMenuItemCollectionFactory MenuItemCollectionFactory { get; }
protected abstract string[] Extensions { get; }
protected abstract string FileIcon { get; }
/// <summary>
/// Inheritors can override this method to modify the file node that is created.
/// </summary>
/// <param name="treeNode"></param>
protected virtual void OnRenderFileNode(ref TreeNode treeNode) { }
/// <summary>
/// Inheritors can override this method to modify the folder node that is created.
/// </summary>
/// <param name="treeNode"></param>
protected virtual void OnRenderFolderNode(ref TreeNode treeNode) =>
// TODO: This isn't the best way to ensure a noop process for clicking a node but it works for now.
treeNode.AdditionalData["jsClickCallback"] = "javascript:void(0);";
protected override ActionResult<TreeNodeCollection> GetTreeNodes(string id, FormCollection queryStrings)
{
protected FileSystemTreeController(
ILocalizedTextService localizedTextService,
UmbracoApiControllerTypeCollection umbracoApiControllerTypeCollection,
IMenuItemCollectionFactory menuItemCollectionFactory,
IEventAggregator eventAggregator
)
: base(localizedTextService, umbracoApiControllerTypeCollection, eventAggregator)
var path = string.IsNullOrEmpty(id) == false && id != Constants.System.RootString
? WebUtility.UrlDecode(id).TrimStart("/")
: "";
IEnumerable<string>? directories = FileSystem?.GetDirectories(path);
var nodes = new TreeNodeCollection();
if (directories is not null)
{
MenuItemCollectionFactory = menuItemCollectionFactory;
}
protected abstract IFileSystem? FileSystem { get; }
protected IMenuItemCollectionFactory MenuItemCollectionFactory { get; }
protected abstract string[] Extensions { get; }
protected abstract string FileIcon { get; }
/// <summary>
/// Inheritors can override this method to modify the file node that is created.
/// </summary>
/// <param name="treeNode"></param>
protected virtual void OnRenderFileNode(ref TreeNode treeNode) { }
/// <summary>
/// Inheritors can override this method to modify the folder node that is created.
/// </summary>
/// <param name="treeNode"></param>
protected virtual void OnRenderFolderNode(ref TreeNode treeNode) {
// TODO: This isn't the best way to ensure a noop process for clicking a node but it works for now.
treeNode.AdditionalData["jsClickCallback"] = "javascript:void(0);";
}
protected override ActionResult<TreeNodeCollection> GetTreeNodes(string id, FormCollection queryStrings)
{
var path = string.IsNullOrEmpty(id) == false && id != Constants.System.RootString
? WebUtility.UrlDecode(id).TrimStart("/")
: "";
var directories = FileSystem?.GetDirectories(path);
var nodes = new TreeNodeCollection();
if (directories is not null)
foreach (var directory in directories)
{
foreach (var directory in directories)
{
var hasChildren = FileSystem is not null && (FileSystem.GetFiles(directory).Any() || FileSystem.GetDirectories(directory).Any());
var hasChildren = FileSystem is not null &&
(FileSystem.GetFiles(directory).Any() || FileSystem.GetDirectories(directory).Any());
var name = Path.GetFileName(directory);
var node = CreateTreeNode(WebUtility.UrlEncode(directory), path, queryStrings, name, "icon-folder", hasChildren);
OnRenderFolderNode(ref node);
if (node != null)
nodes.Add(node);
var name = Path.GetFileName(directory);
TreeNode? node = CreateTreeNode(WebUtility.UrlEncode(directory), path, queryStrings, name,
"icon-folder", hasChildren);
OnRenderFolderNode(ref node);
if (node != null)
{
nodes.Add(node);
}
}
}
//this is a hack to enable file system tree to support multiple file extension look-up
//so the pattern both support *.* *.xml and xml,js,vb for lookups
var files = FileSystem?.GetFiles(path).Where(x =>
//this is a hack to enable file system tree to support multiple file extension look-up
//so the pattern both support *.* *.xml and xml,js,vb for lookups
IEnumerable<string>? files = FileSystem?.GetFiles(path).Where(x =>
{
var extension = Path.GetExtension(x);
if (Extensions.Contains("*"))
{
var extension = Path.GetExtension(x);
return true;
}
if (Extensions.Contains("*"))
return true;
return extension != null && Extensions.Contains(extension.Trim(Constants.CharArrays.Period),
StringComparer.InvariantCultureIgnoreCase);
});
return extension != null && Extensions.Contains(extension.Trim(Constants.CharArrays.Period), StringComparer.InvariantCultureIgnoreCase);
});
if (files is not null)
if (files is not null)
{
foreach (var file in files)
{
foreach (var file in files)
var withoutExt = Path.GetFileNameWithoutExtension(file);
if (withoutExt.IsNullOrWhiteSpace())
{
var withoutExt = Path.GetFileNameWithoutExtension(file);
if (withoutExt.IsNullOrWhiteSpace()) continue;
continue;
}
var name = Path.GetFileName(file);
var node = CreateTreeNode(WebUtility.UrlEncode(file), path, queryStrings, name, FileIcon, false);
OnRenderFileNode(ref node);
if (node != null)
nodes.Add(node);
var name = Path.GetFileName(file);
TreeNode? node = CreateTreeNode(WebUtility.UrlEncode(file), path, queryStrings, name, FileIcon, false);
OnRenderFileNode(ref node);
if (node != null)
{
nodes.Add(node);
}
}
return nodes;
}
protected override ActionResult<TreeNode?> CreateRootNode(FormCollection queryStrings)
return nodes;
}
protected override ActionResult<TreeNode?> CreateRootNode(FormCollection queryStrings)
{
ActionResult<TreeNode?> rootResult = base.CreateRootNode(queryStrings);
if (!(rootResult.Result is null))
{
var rootResult = base.CreateRootNode(queryStrings);
if (!(rootResult.Result is null))
{
return rootResult;
}
var root = rootResult.Value;
//check if there are any children
var treeNodesResult = GetTreeNodes(Constants.System.RootString, queryStrings);
if (!(treeNodesResult.Result is null))
{
return treeNodesResult.Result;
}
if (root is not null)
{
root.HasChildren = treeNodesResult.Value?.Any() ?? false;
}
return root;
return rootResult;
}
protected virtual MenuItemCollection GetMenuForRootNode(FormCollection queryStrings)
TreeNode? root = rootResult.Value;
//check if there are any children
ActionResult<TreeNodeCollection> treeNodesResult = GetTreeNodes(Constants.System.RootString, queryStrings);
if (!(treeNodesResult.Result is null))
{
var menu = MenuItemCollectionFactory.Create();
//set the default to create
menu.DefaultMenuAlias = ActionNew.ActionAlias;
//create action
menu.Items.Add<ActionNew>(LocalizedTextService, opensDialog: true);
//refresh action
menu.Items.Add(new RefreshNode(LocalizedTextService, true));
return menu;
return treeNodesResult.Result;
}
protected virtual MenuItemCollection GetMenuForFolder(string path, FormCollection queryStrings)
if (root is not null)
{
var menu = MenuItemCollectionFactory.Create();
//set the default to create
menu.DefaultMenuAlias = ActionNew.ActionAlias;
//create action
menu.Items.Add<ActionNew>(LocalizedTextService, opensDialog: true);
var hasChildren = FileSystem is not null && (FileSystem.GetFiles(path).Any() || FileSystem.GetDirectories(path).Any());
//We can only delete folders if it doesn't have any children (folders or files)
if (hasChildren == false)
{
//delete action
menu.Items.Add<ActionDelete>(LocalizedTextService, true, opensDialog: true);
}
//refresh action
menu.Items.Add(new RefreshNode(LocalizedTextService, true));
return menu;
root.HasChildren = treeNodesResult.Value?.Any() ?? false;
}
protected virtual MenuItemCollection GetMenuForFile(string path, FormCollection queryStrings)
return root;
}
protected virtual MenuItemCollection GetMenuForRootNode(FormCollection queryStrings)
{
MenuItemCollection menu = MenuItemCollectionFactory.Create();
//set the default to create
menu.DefaultMenuAlias = ActionNew.ActionAlias;
//create action
menu.Items.Add<ActionNew>(LocalizedTextService, opensDialog: true);
//refresh action
menu.Items.Add(new RefreshNode(LocalizedTextService, true));
return menu;
}
protected virtual MenuItemCollection GetMenuForFolder(string path, FormCollection queryStrings)
{
MenuItemCollection menu = MenuItemCollectionFactory.Create();
//set the default to create
menu.DefaultMenuAlias = ActionNew.ActionAlias;
//create action
menu.Items.Add<ActionNew>(LocalizedTextService, opensDialog: true);
var hasChildren = FileSystem is not null &&
(FileSystem.GetFiles(path).Any() || FileSystem.GetDirectories(path).Any());
//We can only delete folders if it doesn't have any children (folders or files)
if (hasChildren == false)
{
var menu = MenuItemCollectionFactory.Create();
//if it's not a directory then we only allow to delete the item
menu.Items.Add<ActionDelete>(LocalizedTextService, opensDialog: true);
return menu;
//delete action
menu.Items.Add<ActionDelete>(LocalizedTextService, true, true);
}
protected override ActionResult<MenuItemCollection> GetMenuForNode(string id, FormCollection queryStrings)
//refresh action
menu.Items.Add(new RefreshNode(LocalizedTextService, true));
return menu;
}
protected virtual MenuItemCollection GetMenuForFile(string path, FormCollection queryStrings)
{
MenuItemCollection menu = MenuItemCollectionFactory.Create();
//if it's not a directory then we only allow to delete the item
menu.Items.Add<ActionDelete>(LocalizedTextService, opensDialog: true);
return menu;
}
protected override ActionResult<MenuItemCollection> GetMenuForNode(string id, FormCollection queryStrings)
{
//if root node no need to visit the filesystem so lets just create the menu and return it
if (id == Constants.System.RootString)
{
//if root node no need to visit the filesystem so lets just create the menu and return it
if (id == Constants.System.RootString)
{
return GetMenuForRootNode(queryStrings);
}
var menu = MenuItemCollectionFactory.Create();
var path = string.IsNullOrEmpty(id) == false && id != Constants.System.RootString
? WebUtility.UrlDecode(id).TrimStart("/")
: "";
var isFile = FileSystem?.FileExists(path) ?? false;
var isDirectory = FileSystem?.DirectoryExists(path) ?? false;
if (isDirectory)
{
return GetMenuForFolder(path, queryStrings);
}
return isFile ? GetMenuForFile(path, queryStrings) : menu;
return GetMenuForRootNode(queryStrings);
}
MenuItemCollection menu = MenuItemCollectionFactory.Create();
var path = string.IsNullOrEmpty(id) == false && id != Constants.System.RootString
? WebUtility.UrlDecode(id).TrimStart("/")
: "";
var isFile = FileSystem?.FileExists(path) ?? false;
var isDirectory = FileSystem?.DirectoryExists(path) ?? false;
if (isDirectory)
{
return GetMenuForFolder(path, queryStrings);
}
return isFile ? GetMenuForFile(path, queryStrings) : menu;
}
}