Merge branch 'feature/SitemapController-Extended' into develop

Simplified the output of the default sitemap; introduced an optional `/Sitemap/Extended` action for exposing all metadata.

Previously, the sitemap output (most) attributes and relationships as additional metadata. Few agents support this metadata, and no current implementations utilize it. The main reason it was in place is to support the legacy Google Custom Search Engine (CSE), which used to support it—but is no longer offered by Google. As that functionality adds a lot of weight to the default sitemap, it's been removed from the default output (87b6d1b). It is still supported, however, it via the `Extended()` action (84c054f), in case future agents provide support for the `<PageMap />` and `<DataObject />` elements.

In addition, a new `MapTopicSitemap()` extension method was introduced (a4b449d) to simplify configuration of the sitemap route for any sites not using e.g. the `MapDefaultControllerRoute()`, which would otherwise cover the `SitemapController`.

Finally, both `MapTopicSitemap()` (a4b449d) and the preexisting `MapTopicRedirect()` (60a220f) extensions are configured in the `OnTopic.AspNetCore.Mvc.Host` project for integration testing.

Author: JeremyCaney

OnTopic.AspNetCore.Mvc.Host/SampleActivator.cs

@@ -102,6 +102,8 @@ public object Create(ControllerContext context) {
           new TopicController(_topicRepository, _topicMappingService),
         nameof(SitemapController) =>
           new SitemapController(_topicRepository),
+        nameof(RedirectController) =>
+          new RedirectController(_topicRepository),
         _ => throw new Exception($"Unknown controller {type.Name}")
       };
 

OnTopic.AspNetCore.Mvc.Host/Startup.cs

@@ -112,11 +112,9 @@ public static void Configure(IApplicationBuilder app, IWebHostEnvironment env) {
       | Configure: MVC
       \-----------------------------------------------------------------------------------------------------------------------*/
       app.UseEndpoints(endpoints => {
-        endpoints.MapControllerRoute(
-          name: "default",
-          pattern: "{controller}/{action=Index}/"
-        );
         endpoints.MapTopicRoute("Web");
+        endpoints.MapTopicSitemap();
+        endpoints.MapTopicRedirect();
         endpoints.MapControllers();
       });
 

OnTopic.AspNetCore.Mvc/Controllers/SitemapController.cs

@@ -91,8 +91,9 @@ public SitemapController(ITopicRepository topicRepository) {
     ///   Provides the Sitemap.org sitemap for the site.
     /// </summary>
     /// <param name="indent">Optionally enables indentation of XML elements in output for human readability.</param>
-    /// <returns>The site's homepage view.</returns>
-    public virtual ActionResult Index(bool indent = false) {
+    /// <param name="includeMetadata">Optionally enables extended metadata associated with each topic.</param>
+    /// <returns>A Sitemap.org sitemap.</returns>
+    public virtual ActionResult Index(bool indent = false, bool includeMetadata = false) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Ensure topics are loaded
@@ -109,7 +110,7 @@ public virtual ActionResult Index(bool indent = false) {
       | Establish sitemap
       \-----------------------------------------------------------------------------------------------------------------------*/
       var declaration           = new XDeclaration("1.0", "utf-8", "no");
-      var sitemap               = GenerateSitemap(rootTopic);
+      var sitemap               = GenerateSitemap(rootTopic, includeMetadata);
       var settings              = indent? SaveOptions.None : SaveOptions.DisableFormatting;
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -119,19 +120,36 @@ public virtual ActionResult Index(bool indent = false) {
 
     }
 
+    /*==========================================================================================================================
+    | GET: /SITEMAP/EXTENDED
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Provides the Sitemap.org sitemap for the site, including extended metadata attributes.
+    /// </summary>
+    /// <remarks>
+    ///   Introducing the metadata makes the sitemap considerably larger. However, it also means that some agents will index the
+    ///   additional information and make it available for querying. For instance, the (now defunct) Google Custom Search Engine
+    ///   (CSE) would previously allow queries to be filtered based on metadata attributes exposed via the sitemap.
+    /// </remarks>
+    /// <param name="indent">Optionally enables indentation of XML elements in output for human readability.</param>
+    /// <returns>A Sitemap.org sitemap.</returns>
+    public virtual ActionResult Extended(bool indent = false) => Index(indent, true);
+
     /*==========================================================================================================================
     | METHOD: GENERATE SITEMAP
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
     ///   Given a root topic, generates an XML-formatted sitemap.
     /// </summary>
-    /// <returns>The site's homepage view.</returns>
+    /// <param name="topic">The topic to add to the sitemap.</param>
+    /// <param name="includeMetadata">Optionally enables extended metadata associated with each topic.</param>
+    /// <returns>A Sitemap.org sitemap.</returns>
     [Obsolete("The GenerateSitemap() method should not be public. It will be marked private in OnTopic Library 5.0.")]
-    public virtual XDocument GenerateSitemap(Topic rootTopic) =>
+    public virtual XDocument GenerateSitemap(Topic rootTopic, bool includeMetadata = false) =>
       new XDocument(
         new XElement(_sitemapNamespace + "urlset",
           from topic in rootTopic?.Children
-          select AddTopic(topic)
+          select AddTopic(topic, includeMetadata)
         )
       );
 
@@ -141,8 +159,10 @@ select AddTopic(topic)
     /// <summary>
     ///   Given a <see cref="Topic"/>, adds it to a given <see cref="XmlNode"/>.
     /// </summary>
+    /// <param name="topic">The topic to add to the sitemap.</param>
+    /// <param name="includeMetadata">Optionally enables extended metadata associated with each topic.</param>
     [Obsolete("The AddTopic() method should not be public. It will be marked private in OnTopic Library 5.0.")]
-    public IEnumerable<XElement> AddTopic(Topic topic) {
+    public IEnumerable<XElement> AddTopic(Topic topic, bool includeMetadata = false) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish return collection
@@ -171,21 +191,23 @@ public IEnumerable<XElement> AddTopic(Topic topic) {
         new XElement(_sitemapNamespace + "changefreq", "monthly"),
         new XElement(_sitemapNamespace + "lastmod", lastModified.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)),
         new XElement(_sitemapNamespace + "priority", 1),
-        new XElement(_pagemapNamespace + "PageMap",
+        includeMetadata? new XElement(_pagemapNamespace + "PageMap",
           new XElement(_pagemapNamespace + "DataObject",
             new XAttribute("type", topic.ContentType?? "Page"),
             getAttributes()
           ),
           getRelationships()
-        )
+        ) : null
       );
-      topics.Add(topicElement);
+      if (!topic.ContentType!.Equals("Container", StringComparison.InvariantCultureIgnoreCase)) {
+        topics.Add(topicElement);
+      }
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Iterate over children
       \-----------------------------------------------------------------------------------------------------------------------*/
       foreach (var childTopic in topic.Children) {
-        topics.AddRange(AddTopic(childTopic));
+        topics.AddRange(AddTopic(childTopic, includeMetadata));
       }
 
       return topics;

OnTopic.AspNetCore.Mvc/ServiceCollectionExtensions.cs

@@ -209,6 +209,25 @@ public static void MapImplicitAreaControllerRoute(this IEndpointRouteBuilder rou
     public static void MapImplicitAreaControllerRoute(this IEndpointRouteBuilder routes) =>
       routes.MapDynamicControllerRoute<TopicRouteValueTransformer>("{area:exists}/{action=Index}");
 
+    /*==========================================================================================================================
+    | EXTENSION: MAP TOPIC SITEMAP (IENDPOINTROUTEBUILDER)
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Adds the <c>Sitemap/{action=Index}</c> endpoint route for the OnTopic sitemap.
+    /// </summary>
+    /// <remarks>
+    ///   For most implementations, this will be covered by the default route, such as that implemented by the standard <see
+    ///   cref="ControllerEndpointRouteBuilderExtensions.MapDefaultControllerRoute(IEndpointRouteBuilder)"/> method that ships
+    ///   with ASP.NET. This extension method is provided as a convenience method for implementations that aren't using the
+    ///   standard route, for whatever reason, and want a specific route setup for the sitemap.
+    /// </remarks>
+    public static ControllerActionEndpointConventionBuilder MapTopicSitemap(this IEndpointRouteBuilder routes) =>
+      routes.MapControllerRoute(
+        name: "TopicSitemap",
+        pattern: "Sitemap/{action=Index}",
+        defaults: new { controller = "Sitemap" }
+      );
+
     /*==========================================================================================================================
     | EXTENSION: MAP TOPIC REDIRECT (IENDPOINTROUTEBUILDER)
     \-------------------------------------------------------------------------------------------------------------------------*/