Umbraco-CMS/src/Umbraco.Cms.Api.Management/Controllers/Dictionary/Tree/DictionaryTreeControllerBase.cs

using Microsoft.AspNetCore.Mvc;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Api.Management.Controllers.Tree;
using Umbraco.Cms.Api.Management.ViewModels.Tree;
using Umbraco.Cms.Api.Management.Routing;

namespace Umbraco.Cms.Api.Management.Controllers.Dictionary.Tree;

[ApiVersion("1.0")]
[ApiController]
[VersionedApiBackOfficeRoute($"{Constants.Web.RoutePath.Tree}/dictionary")]
[ApiExplorerSettings(GroupName = "Dictionary")]
// NOTE: at the moment dictionary items (renamed to dictionary tree) aren't supported by EntityService, so we have little use of the
// tree controller base. We'll keep it though, in the hope that we can mend EntityService.
public class DictionaryTreeControllerBase : EntityTreeControllerBase<EntityTreeItemViewModel>
{
    public DictionaryTreeControllerBase(IEntityService entityService, ILocalizationService localizationService)
        : base(entityService) =>
        LocalizationService = localizationService;

    // dictionary items do not currently have a known UmbracoObjectType, so we'll settle with Unknown for now
    protected override UmbracoObjectTypes ItemObjectType => UmbracoObjectTypes.Unknown;

    protected ILocalizationService LocalizationService { get; }

    protected EntityTreeItemViewModel[] MapTreeItemViewModels(Guid? parentKey, IDictionaryItem[] dictionaryItems)
        => dictionaryItems.Select(dictionaryItem => new EntityTreeItemViewModel
        {
            Icon = Constants.Icons.RelationType,
            Name = dictionaryItem.ItemKey,
            Key = dictionaryItem.Key,
            Type = Constants.UdiEntityType.DictionaryItem,
            // FIXME - do not hardcode HasChildren to false for all dictionary items
            HasChildren = false,
            IsContainer = LocalizationService.GetDictionaryItemChildren(dictionaryItem.Key).Any(),
            ParentKey = parentKey
        }).ToArray();

    // localization service does not (yet) allow pagination of dictionary items, we have to do it in memory for now
    protected IDictionaryItem[] PaginatedDictionaryItems(long pageNumber, int pageSize, IEnumerable<IDictionaryItem> allDictionaryItems, out long totalItems)
    {
        IDictionaryItem[] allDictionaryItemsAsArray = allDictionaryItems.ToArray();

        totalItems = allDictionaryItemsAsArray.Length;
        return allDictionaryItemsAsArray
            .OrderBy(item => item.ItemKey)
            .Skip((int)pageNumber * pageSize)
            .Take(pageSize)
            .ToArray();
    }
}