Adding UriAugmenterService in order to augment Url generation.

Geta.Optimizely.Sitemaps.sln

@@ -7,9 +7,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Sandbox", "Sandbox", "{9003
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Geta.Optimizely.Sitemaps", "src\Geta.Optimizely.Sitemaps\Geta.Optimizely.Sitemaps.csproj", "{A56D25DD-73FB-4754-B054-C5CD9B52804F}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Geta.Optimizely.Sitemaps.Commerce", "src\Geta.Optimizely.Sitemaps.Commerce\Geta.Optimizely.Sitemaps.Commerce.csproj", "{39B5430D-35AF-4413-980B-1CE51B367DC7}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Geta.Optimizely.Sitemaps.Commerce", "src\Geta.Optimizely.Sitemaps.Commerce\Geta.Optimizely.Sitemaps.Commerce.csproj", "{39B5430D-35AF-4413-980B-1CE51B367DC7}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Foundation", "sandbox\Foundation\src\Foundation\Foundation.csproj", "{82A14BA5-4A85-4DC3-833E-37EBC47BB891}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Foundation", "sandbox\Foundation\src\Foundation\Foundation.csproj", "{82A14BA5-4A85-4DC3-833E-37EBC47BB891}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

README.md

@@ -18,6 +18,7 @@ This tool allows you to generate xml sitemaps for search engines to better index
 - ability to include pages that are in a different branch than the one of the start page
 - ability to generate sitemaps for mobile pages
 - it also supports multi-site and multi-language environments
+- ability to augment URL generation for parameterized pages using QueryStrings
 
 See the [editor guide](docs/editor-guide.md) for more information.
 
@@ -59,6 +60,23 @@ services.AddSitemaps(x =>
 }, p => p.RequireRole(Roles.Administrators));
 ```
 
+In order to augment Urls for the PersonListPage with the corresponding querystring parameters for said page, please review the [SitemapUriParameterAugmenterService class](sandbox/Foundation/src/Foundation/Infrastructure/Cms/Services/SitemapUriParameterAugmenterService.cs) within the Foundation project:
+
+```csharp
+services.AddSitemaps(uriAugmenterService: sp => sp.GetInstance<SitemapUriParameterAugmenterService>());
+```
+
+Or, alternatively:
+```csharp
+services.AddSitemaps(x =>
+{
+  x.EnableLanguageDropDownInAdmin = false;
+  x.EnableRealtimeCaching = true;
+  x.EnableRealtimeSitemap = false;
+}, sp => sp.GetInstance<SitemapUriParameterAugmenterService>());
+```
+
+
 And for the Commerce support add a call to:
 ```csharp
 services.AddSitemapsCommerce();

sandbox/Foundation/src/Foundation/Infrastructure/Cms/Services/SitemapUriParameterAugmenterService.cs

@@ -0,0 +1,54 @@
+using EPiServer;
+using EPiServer.Core;
+using EPiServer.DataAbstraction;
+using Foundation.Features.People.PersonItemPage;
+using Geta.Optimizely.Sitemaps;
+using Geta.Optimizely.Sitemaps.Services;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace Foundation.Infrastructure.Cms.Services
+{
+    public class SitemapUriParameterAugmenterService : IUriAugmenterService
+    {
+        private readonly IContentTypeRepository _contentTypeRepository;
+        private readonly IContentModelUsage _contentModelUsage;
+        private readonly IContentRepository _contentRepository;
+
+        public SitemapUriParameterAugmenterService(IContentTypeRepository contentTypeRepository, IContentModelUsage contentModelUsage, IContentRepository contentRepository)
+        {
+            _contentTypeRepository = contentTypeRepository;
+            _contentModelUsage = contentModelUsage;
+            _contentRepository = contentRepository;
+        }
+
+        public IEnumerable<Uri> GetAugmentUri(IContent content, CurrentLanguageContent languageContentInfo, Uri fullUri)
+        {
+            if (content is PageData pageContent)
+            {
+                if (pageContent.PageTypeName == nameof(Features.People.PersonListPage))
+                {
+                    var fullUriString = fullUri.ToString();
+
+                    var personPageType = _contentTypeRepository.Load<PersonPage>();
+                    var usages = _contentModelUsage.ListContentOfContentType(personPageType).Select(c => _contentRepository.Get<PersonPage>(c.ContentLink));
+                    // Group all of the results by the querystring parameters that drive the page.
+                    var nameSectorLocations = usages.GroupBy(k => new { k.Name, k.Sector, k.Location });
+
+                    // Enumerate the total set of expected name/sectors/locations in ordr for them to be indexed.
+                    foreach (var nameSectorLocation in nameSectorLocations)
+                    {
+                        var augmentedUri = new Uri($"{fullUriString}?name={nameSectorLocation.Key.Name}&sector={nameSectorLocation.Key.Sector}&location={nameSectorLocation.Key.Location}");
+                        yield return augmentedUri;
+                    }
+                }
+                else
+                {
+                    yield return fullUri;
+                }
+            }
+        }
+    }
+}

sandbox/Foundation/src/Foundation/Startup.cs

@@ -1,9 +1,12 @@
-using EPiServer.Authorization;
+using EPiServer;
+using EPiServer.Authorization;
 using EPiServer.ContentApi.Cms;
 using EPiServer.ContentApi.Cms.Internal;
 using EPiServer.ContentDefinitionsApi;
 using EPiServer.ContentManagementApi;
+using EPiServer.Core;
 using EPiServer.Data;
+using EPiServer.DataAbstraction;
 using EPiServer.Framework.Web.Resources;
 using EPiServer.Labs.ContentManager;
 using EPiServer.OpenIDConnect;
@@ -15,13 +18,15 @@
 using Foundation.Infrastructure;
 using Foundation.Infrastructure.Cms.Extensions;
 using Foundation.Infrastructure.Cms.ModelBinders;
+using Foundation.Infrastructure.Cms.Services;
 using Foundation.Infrastructure.Cms.Users;
 using Foundation.Infrastructure.Display;
 using Geta.NotFoundHandler.Infrastructure.Configuration;
 using Geta.NotFoundHandler.Infrastructure.Initialization;
 using Geta.NotFoundHandler.Optimizely;
 using Geta.Optimizely.Sitemaps;
 using Geta.Optimizely.Sitemaps.Commerce;
+using Geta.Optimizely.Sitemaps.Services;
 using Jhoose.Security.DependencyInjection;
 using Mediachase.Commerce.Anonymous;
 using Mediachase.Commerce.Orders;
@@ -91,7 +96,9 @@ public void ConfigureServices(IServiceCollection services)
             services.AddDetection();
             services.AddTinyMceConfiguration();
 
-            services.AddSitemaps();
+            services.AddSingleton<SitemapUriParameterAugmenterService>();
+            // Implement the UriAugmenterServiceImplementationFactory in order to enumerate the PersonalListPage querystring parameters.
+            services.AddSitemaps(uriAugmenterService: sp => sp.GetInstance<SitemapUriParameterAugmenterService>());
             services.AddSitemapsCommerce();
 
             //site specific

src/Geta.Optimizely.Sitemaps.Commerce/CommerceAndStandardSitemapXmlGenerator.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Geta Digital. All rights reserved.
+// Copyright (c) Geta Digital. All rights reserved.
 // Licensed under Apache-2.0. See the LICENSE file in the project root for more information
 
 using System.Collections.Generic;
@@ -10,6 +10,7 @@
 using EPiServer.Web;
 using EPiServer.Web.Routing;
 using Geta.Optimizely.Sitemaps.Repositories;
+using Geta.Optimizely.Sitemaps.Services;
 using Geta.Optimizely.Sitemaps.Utils;
 using Geta.Optimizely.Sitemaps.XML;
 using Mediachase.Commerce.Catalog;
@@ -33,6 +34,7 @@ public CommerceAndStandardSitemapXmlGenerator(
             ILanguageBranchRepository languageBranchRepository,
             ReferenceConverter referenceConverter,
             IContentFilter contentFilter,
+            IUriAugmenterService uriAugmenterService,
             ISynchronizedObjectInstanceCache objectCache,
             IMemoryCache memoryCache,
             ILogger<CommerceAndStandardSitemapXmlGenerator> logger)
@@ -44,6 +46,7 @@ public CommerceAndStandardSitemapXmlGenerator(
                 languageBranchRepository,
                 referenceConverter,
                 contentFilter,
+                uriAugmenterService,
                 objectCache,
                 memoryCache,
                 logger)

src/Geta.Optimizely.Sitemaps.Commerce/CommerceSitemapXmlGenerator.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Geta Digital. All rights reserved.
+// Copyright (c) Geta Digital. All rights reserved.
 // Licensed under Apache-2.0. See the LICENSE file in the project root for more information
 
 using System;
@@ -12,6 +12,7 @@
 using EPiServer.Web;
 using EPiServer.Web.Routing;
 using Geta.Optimizely.Sitemaps.Repositories;
+using Geta.Optimizely.Sitemaps.Services;
 using Geta.Optimizely.Sitemaps.Utils;
 using Geta.Optimizely.Sitemaps.XML;
 using Mediachase.Commerce.Catalog;
@@ -36,6 +37,7 @@ public CommerceSitemapXmlGenerator(
             ILanguageBranchRepository languageBranchRepository,
             ReferenceConverter referenceConverter,
             IContentFilter contentFilter,
+            IUriAugmenterService uriAugmenterService,
             ISynchronizedObjectInstanceCache objectCache,
             IMemoryCache memoryCache,
             ILogger<CommerceSitemapXmlGenerator> logger)
@@ -46,6 +48,7 @@ public CommerceSitemapXmlGenerator(
                 siteDefinitionRepository,
                 languageBranchRepository,
                 contentFilter,
+                uriAugmenterService,
                 objectCache,
                 memoryCache,
                 logger)

src/Geta.Optimizely.Sitemaps/Configuration/SitemapOptions.cs

@@ -1,9 +1,12 @@
-namespace Geta.Optimizely.Sitemaps.Configuration
+using System;
+using Geta.Optimizely.Sitemaps.Services;
+
+namespace Geta.Optimizely.Sitemaps.Configuration
 {
     public class SitemapOptions
     {
         public bool EnableRealtimeSitemap { get; set; } = false;
         public bool EnableRealtimeCaching { get; set; } = true;
         public bool EnableLanguageDropDownInAdmin { get; set; } = false;
     }
-}
+}

src/Geta.Optimizely.Sitemaps/ServiceCollectionExtensions.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Linq;
 using EPiServer.Authorization;
 using EPiServer.Shell.Modules;
@@ -7,6 +7,7 @@
 using Geta.Optimizely.Sitemaps.Entities;
 using Geta.Optimizely.Sitemaps.Models;
 using Geta.Optimizely.Sitemaps.Repositories;
+using Geta.Optimizely.Sitemaps.Services;
 using Geta.Optimizely.Sitemaps.Utils;
 using Geta.Optimizely.Sitemaps.XML;
 using Microsoft.AspNetCore.Authorization;
@@ -19,22 +20,25 @@ public static class ServiceCollectionExtensions
     {
         private static readonly Action<AuthorizationPolicyBuilder> DefaultPolicy = p => p.RequireRole(Roles.WebAdmins);
 
-        public static IServiceCollection AddSitemaps(this IServiceCollection services)
+        public static IServiceCollection AddSitemaps(this IServiceCollection services,
+            Func<IServiceProvider, IUriAugmenterService> uriAugmenterService = null)
         {
-            return AddSitemaps(services, _ => { }, DefaultPolicy);
+            return AddSitemaps(services, _ => { }, DefaultPolicy, uriAugmenterService);
         }
 
         public static IServiceCollection AddSitemaps(
             this IServiceCollection services,
-            Action<SitemapOptions> setupAction)
+            Action<SitemapOptions> setupAction,
+            Func<IServiceProvider, IUriAugmenterService> uriAugmenterService = null)
         {
-            return AddSitemaps(services, setupAction, DefaultPolicy);
+            return AddSitemaps(services, setupAction, DefaultPolicy, uriAugmenterService);
         }
 
         public static IServiceCollection AddSitemaps(
             this IServiceCollection services,
             Action<SitemapOptions> setupAction,
-            Action<AuthorizationPolicyBuilder> configurePolicy)
+            Action<AuthorizationPolicyBuilder> configurePolicy,
+            Func<IServiceProvider, IUriAugmenterService> uriAugmenterService = null)
         {
             AddModule(services);
 
@@ -52,6 +56,15 @@ public static IServiceCollection AddSitemaps(
                 setupAction(options);
                 configuration.GetSection("Geta:Sitemaps").Bind(options);
             });
+
+            if (uriAugmenterService != null)
+            {
+                services.AddSingleton(typeof(IUriAugmenterService), uriAugmenterService);
+            }
+            else
+            {
+                services.AddSingleton<IUriAugmenterService, DefaultUriAugmenterService>();
+            }
 
             services.AddAuthorization(options =>
             {

src/Geta.Optimizely.Sitemaps/Services/DefaultUriAugmenterService.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using EPiServer.Core;
+using EPiServer.ServiceLocation;
+
+namespace Geta.Optimizely.Sitemaps.Services
+{
+    public class DefaultUriAugmenterService : IUriAugmenterService
+    {
+        public IEnumerable<Uri> GetAugmentUri(IContent content, CurrentLanguageContent languageContentInfo, Uri fullUri)
+        {
+            return new Uri[] { fullUri };
+        }
+    }
+}

src/Geta.Optimizely.Sitemaps/Services/IUriAugmenterService.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using EPiServer.Core;
+
+namespace Geta.Optimizely.Sitemaps.Services
+{
+    public interface IUriAugmenterService
+    {
+        /// <summary>
+        /// Allows sitemap implementer an easy facility to take a simple url and expand it in a number of ways, includig parameterizing it with QueryStrings.
+        /// </summary>
+        /// <param name="content">Original content of page URL being created.</param>
+        /// <param name="languageContentInfo">Language for URI</param>
+        /// <param name="originUri">Origin URI to be included in sitemap</param>
+        /// <returns>Must include origin to be included in sitemap</returns>
+        IEnumerable<Uri> GetAugmentUri(IContent content, CurrentLanguageContent languageContentInfo, Uri originUri);
+    }
+}

src/Geta.Optimizely.Sitemaps/XML/MobileSitemapXmlGenerator.cs

@@ -9,6 +9,7 @@
 using EPiServer.Web;
 using EPiServer.Web.Routing;
 using Geta.Optimizely.Sitemaps.Repositories;
+using Geta.Optimizely.Sitemaps.Services;
 using Geta.Optimizely.Sitemaps.Utils;
 using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.Logging;
@@ -24,6 +25,7 @@ public MobileSitemapXmlGenerator(
             ISiteDefinitionRepository siteDefinitionRepository,
             ILanguageBranchRepository languageBranchRepository,
             IContentFilter contentFilter,
+            IUriAugmenterService uriAugmenterService,
             ISynchronizedObjectInstanceCache objectCache,
             IMemoryCache cache,
             ILogger<MobileSitemapXmlGenerator> logger)
@@ -34,6 +36,7 @@ public MobileSitemapXmlGenerator(
                 siteDefinitionRepository,
                 languageBranchRepository,
                 contentFilter,
+                uriAugmenterService,
                 objectCache,
                 cache,
                 logger)