Introduced optional includeMetadata parameter

JeremyCaney · JeremyCaney · commit 87b6d1b1821c · 2020-08-17T17:48:03.000-07:00
The `includeMetadata` parameter—which defaults to `false`—allows the inclusion of extended metadata such as (a limited set of) topic attributes as well as topic relationships to be included in the sitemap. These were previously supported as they could be used by Google Custom Search Engine (CSE) in order to provide site-specific queries. While that was a really useful feature, CSE is no longer supported by Google, and thus this functionality is no longer used.

(Technically, this is a breaking change. As no APIs that implementers are using currently support or rely on this, however, we're not worried about that change.)

As other agents or search engines may, in the future, offer support for extended attributes via the `&lt;PageMap /&gt;` and `&lt;DataObject /&gt;` elements, I've kept that functionality in via the optional `includeMetadata` parameter, thus allowing this to still be used if needed.

The immediate affect of this is to (dramatically) reduce the size of the default `/Sitemap` route, since it wil no longer include metadata for attributes and relationships on every topic.
diff --git a/OnTopic.AspNetCore.Mvc/Controllers/SitemapController.cs b/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;
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -125,13 +126,15 @@ public virtual ActionResult Index(bool indent = false) {
     /// <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 +144,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 +176,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;
