using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Net;
using System.Net.Http.Formatting;
using System.Threading.Tasks;
using System.Web.Http;
using Umbraco.Core;
using Umbraco.Core.Models;
using Umbraco.Core.Services;
using Umbraco.Web.Composing;
using Umbraco.Web.Models.Trees;
using Umbraco.Web.Mvc;
using Umbraco.Web.WebApi;
using Umbraco.Web.WebApi.Filters;
using Constants = Umbraco.Core.Constants;
namespace Umbraco.Web.Trees
{
[AngularJsonOnlyConfiguration]
[PluginController("UmbracoTrees")]
public class ApplicationTreeController : UmbracoAuthorizedApiController
{
///
/// Fetches all registered trees and groups them together if they have a [CoreTree]
/// Attribute with a 'TreeGroup' property set
/// This allows the settings section trees to be grouped by Settings, Templating & Other
///
private static readonly Lazy>> CoreTrees
= new Lazy>>(() =>
Current.Services.ApplicationTreeService.GetAllTypes()
.Select(x => (TreeType: x, TreeGroup: x.GetCustomAttribute(false)?.TreeGroup))
.GroupBy(x => x.TreeGroup)
.ToList());
///
/// Returns the tree nodes for an application
///
/// The application to load tree for
/// An optional single tree alias, if specified will only load the single tree for the request app
///
/// An optional bool (defaults to true), if set to false it will also load uninitialized trees
///
[HttpQueryStringFilter("queryStrings")]
public async Task GetApplicationTrees(string application, string tree, FormDataCollection queryStrings, bool onlyInitialized = true)
{
application = application.CleanForXss();
if (string.IsNullOrEmpty(application)) throw new HttpResponseException(HttpStatusCode.NotFound);
//find all tree definitions that have the current application alias
var appTrees = Services.ApplicationTreeService.GetApplicationTrees(application, onlyInitialized).ToArray();
if (string.IsNullOrEmpty(tree) == false || appTrees.Length <= 1)
{
var apptree = string.IsNullOrEmpty(tree) == false
? appTrees.SingleOrDefault(x => x.Alias == tree)
: appTrees.SingleOrDefault();
if (apptree == null) throw new HttpResponseException(HttpStatusCode.NotFound);
var result = await GetRootForSingleAppTree(
apptree,
Constants.System.Root.ToString(CultureInfo.InvariantCulture),
queryStrings,
application);
//this will be null if it cannot convert to a single root section
if (result != null)
{
return result;
}
}
var collection = new TreeNodeCollection();
foreach (var apptree in appTrees)
{
//return the root nodes for each tree in the app
var rootNode = await GetRootForMultipleAppTree(apptree, queryStrings);
//This could be null if the tree decides not to return it's root (i.e. the member type tree does this when not in umbraco membership mode)
if (rootNode != null)
{
collection.Add(rootNode);
}
}
//Don't apply fancy grouping logic futher down, if we only have one group of items
var hasGroups = CoreTrees.Value.Count > 0;
if (!hasGroups)
{
var multiTree = TreeRootNode.CreateMultiTreeRoot(collection);
multiTree.Name = Services.TextService.Localize("sections/" + application);
return multiTree;
}
var rootNodeGroups = new List();
//Group trees by [CoreTree] attribute with a TreeGroup property
foreach (var treeSectionGroup in CoreTrees.Value)
{
var treeGroupName = treeSectionGroup.Key;
var groupNodeCollection = new TreeNodeCollection();
foreach (var treeItem in treeSectionGroup)
{
//Item1 tuple - is the type from all tree types
var treeItemType = treeItem.Item1;
var findAppTree = appTrees.FirstOrDefault(x => x.GetRuntimeType() == treeItemType);
if (findAppTree != null)
{
//Now we need to get the 'TreeNode' which is in 'collection'
var treeItemNode = collection.FirstOrDefault(x => x.AdditionalData["treeAlias"].ToString() == findAppTree.Alias);
if (treeItemNode != null)
{
//Add to a new list/collection
groupNodeCollection.Add(treeItemNode);
}
}
}
//If treeGroupName == null then its third party
if (treeGroupName == null)
{
//This is used for the localisation key
//treeHeaders/thirdPartyGroup
treeGroupName = "thirdPartyGroup";
}
if (groupNodeCollection.Count > 0)
{
var groupRoot = TreeRootNode.CreateGroupNode(groupNodeCollection);
groupRoot.Name = Services.TextService.Localize("treeHeaders/" + treeGroupName);
rootNodeGroups.Add(groupRoot);
}
}
return TreeRootNode.CreateGroupedMultiTreeRoot(new TreeNodeCollection(rootNodeGroups.OrderBy(x => x.Name)));
}
///
/// Get the root node for an application with multiple trees
///
///
///
///
private async Task GetRootForMultipleAppTree(ApplicationTree configTree, FormDataCollection queryStrings)
{
if (configTree == null) throw new ArgumentNullException(nameof(configTree));
try
{
var byControllerAttempt = await configTree.TryGetRootNodeFromControllerTree(queryStrings, ControllerContext);
if (byControllerAttempt.Success)
{
return byControllerAttempt.Result;
}
}
catch (HttpResponseException)
{
//if this occurs its because the user isn't authorized to view that tree, in this case since we are loading multiple trees we
//will just return null so that it's not added to the list.
return null;
}
var legacyAttempt = configTree.TryGetRootNodeFromLegacyTree(queryStrings, Url, configTree.ApplicationAlias);
if (legacyAttempt.Success)
{
return legacyAttempt.Result;
}
throw new ApplicationException("Could not get root node for tree type " + configTree.Alias);
}
///
/// Get the root node for an application with one tree
///
///
///
///
///
///
private async Task GetRootForSingleAppTree(ApplicationTree configTree, string id, FormDataCollection queryStrings, string application)
{
var rootId = Constants.System.Root.ToString(CultureInfo.InvariantCulture);
if (configTree == null) throw new ArgumentNullException(nameof(configTree));
var byControllerAttempt = configTree.TryLoadFromControllerTree(id, queryStrings, ControllerContext);
if (byControllerAttempt.Success)
{
var rootNode = await configTree.TryGetRootNodeFromControllerTree(queryStrings, ControllerContext);
if (rootNode.Success == false)
{
//This should really never happen if we've successfully got the children above.
throw new InvalidOperationException("Could not create root node for tree " + configTree.Alias);
}
var sectionRoot = TreeRootNode.CreateSingleTreeRoot(
rootId,
rootNode.Result.ChildNodesUrl,
rootNode.Result.MenuUrl,
rootNode.Result.Name,
byControllerAttempt.Result);
//assign the route path based on the root node, this means it will route there when the section is navigated to
//and no dashboards will be available for this section
sectionRoot.RoutePath = rootNode.Result.RoutePath;
foreach (var d in rootNode.Result.AdditionalData)
{
sectionRoot.AdditionalData[d.Key] = d.Value;
}
return sectionRoot;
}
var legacyAttempt = configTree.TryLoadFromLegacyTree(id, queryStrings, Url, configTree.ApplicationAlias);
if (legacyAttempt.Success)
{
var sectionRoot = TreeRootNode.CreateSingleTreeRoot(
rootId,
"", //TODO: I think we'll need this in this situation!
Url.GetUmbracoApiService("GetMenu", rootId)
+ "&parentId=" + rootId
+ "&treeType=" + application
+ "§ion=" + application,
"", //TODO: I think we'll need this in this situation!
legacyAttempt.Result);
sectionRoot.AdditionalData.Add("treeAlias", configTree.Alias);
return sectionRoot;
}
throw new ApplicationException("Could not render a tree for type " + configTree.Alias);
}
}
}