Add support for indexing protected nodes in the External index

[aguyfromdenmark]

There should be a simple way to make the External index index protected nodes. Maybe a flag in the appSettings file.

Umbraco CMS is a great foundation for an intranet type application, and it's fairly easy to add and modify content in the External index to quickly implement search functionality. But the External index becomes useless when you protect your website.

This issue is made worse by the lack of guides/tutorials for creating a custom index in Umbraco v9, let alone one that shows how to index protected content.

[nul800sebastiaan]

Hi there @aguyfromdenmark, we have no plans to include protected nodes in the index by default or by configurations at this point.

I've found some examples for v9 that might help you until we have more documentation

• https://gist.github.com/AaronSadlerUK/baa1aa299115cd5207c50c7230caf4ec
• https://our.umbraco.com/forum/using-umbraco-and-getting-started/108103-how-to-create-an-index-in-umbraco-v9
• https://www.umbrajobs.com/blog/posts/2021/june/umbraco-9-examine-creating-a-custom-index/

For further questions, make sure to head on over to https://our.umbraco.com and ask follow up questions there! 👍

[aguyfromdenmark]

Hi Sebastian,
All right then. I am curious why then?

I have already had a look at the examples you provide. But none of them shows how to index protected nodes. I have been toying around with code like in the first example, but it seems that it might actually be impossible to do, following that example. The property for SupportProtectedContent in the IContentValueSetValidator is get only...

[bjarnef]

In Umbraco 8 it was something like the following to index protected content
https://our.umbraco.com/forum/umbraco-8/97801-umbraco-8-examine-index-supportprotected

using Examine;
using Umbraco.Core;
using Umbraco.Core.Composing;
using Umbraco.Core.Scoping;
using Umbraco.Core.Services;
using Umbraco.Examine;
using Umbraco.Web.Search;

namespace MyProject.Core.Composing
{
    //[ComposeAfter(typeof(ExamineComposer))]
    public class CustomizeIndexComposer : IUserComposer
    {
        public void Compose(Composition composition)
        {
            // Replace the default IUmbracoIndexConfig definition
            composition.RegisterUnique<IUmbracoIndexConfig, CustomIndexConfig>();
        }
    }

    // Inherit from the default
    public class CustomIndexConfig : UmbracoIndexConfig, IUmbracoIndexConfig
    {
        private readonly IPublicAccessService _publicAccessService;
        private readonly IScopeProvider _scopeProvider;

        public CustomIndexConfig(IPublicAccessService publicAccessService, IScopeProvider scopeProvider)
            : base(publicAccessService)
        {
            _publicAccessService = publicAccessService;
            _scopeProvider = scopeProvider;
        }

        // Explicit implementation - overrides base class.
        IContentValueSetValidator IUmbracoIndexConfig.GetContentValueSetValidator()
        {
            bool supportProtectedContent = true;

            return new ContentValueSetValidator(false, supportProtectedContent, _publicAccessService, _scopeProvider);
        }

        // Explicit implementation - overrides base class
        IValueSetValidator IUmbracoIndexConfig.GetMemberValueSetValidator()
        {
            var excludeFields = Umbraco.Core.Constants.Conventions.Member.GetStandardPropertyTypeStubs().Keys;

            // include everything except the above
            return new MemberValueSetValidator(null, null, null, excludeFields);
        }

        // Explicit implementation - overrides base class.
        IContentValueSetValidator IUmbracoIndexConfig.GetPublishedContentValueSetValidator()
        {
            bool supportProtectedContent = true;

            return new ContentValueSetValidator(true, supportProtectedContent, _publicAccessService, _scopeProvider);
        }
    }
}

[mistyn8]

think this should do it to support protected in the externalIndex in v11.3.1+ maybe lower..

using Examine;
using Examine.Lucene;
using Microsoft.Extensions.Options;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.Scoping;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Infrastructure.Examine;

namespace www.Extensions.Examine
{
    public sealed class ConfigureExamineIndexOptions : IConfigureNamedOptions<LuceneDirectoryIndexOptions>
    {
        public readonly IPublicAccessService _publicAccessService;
        [Obsolete("Update when Umbraco Core ContentValueSetValidator is updated")]
        private readonly IScopeProvider _scopeProvider;

        [Obsolete("Update when Umbraco Core ContentValueSetValidator is updated")]
        public ConfigureExamineIndexOptions(IPublicAccessService publicAccessService, IScopeProvider scopeProvider)
        {
            _publicAccessService = publicAccessService;
            _scopeProvider = scopeProvider;
        }

        [Obsolete("Update when Umbraco Core ContentValueSetValidator is updated")]
        public void Configure(string? name, LuceneDirectoryIndexOptions options)
        {
            bool supportProtectedContent = true;

            switch (name)
            {
                //NB you need to rebuild the examine index for these changes to take effect
                case Constants.UmbracoIndexes.ExternalIndexName:
                    options.Validator = new ContentValueSetValidator(true, supportProtectedContent, _publicAccessService, _scopeProvider);
                    break;
            }
        }

        public void Configure(LuceneDirectoryIndexOptions options)
                       => throw new NotImplementedException("This is never called and is just part of the interface");
    }

    public class ConfigureExamineIndexOptionsComposer : IComposer
    {
        public void Compose(IUmbracoBuilder builder)
        {
            // Custom Examine configuration
            builder.Services.ConfigureOptions<ConfigureExamineIndexOptions>();
        }
    }
}