-
-
Save alindgren/1439022194a472d83ddf to your computer and use it in GitHub Desktop.
@inherits Umbraco.Web.Mvc.UmbracoTemplatePage | |
@using System.Linq; | |
@{ | |
Layout = null; | |
Response.ContentType = "text/xml"; | |
}<?xml version='1.0' encoding='UTF-8' ?> | |
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" | |
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |
xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"> | |
@ListChildNodes(Umbraco.TypedContent(UmbracoContext.Current.PageId).AncestorOrSelf(1)) | |
</urlset> | |
@helper ListChildNodes(IPublishedContent startNode) | |
{ | |
foreach (var node in startNode.Children.Where("hideInXmlSitemap == false")) | |
{ | |
if (node.TemplateId > 0) | |
{ | |
<url> | |
<loc>@GetUrlWithDomainPrefix(node.Url)</loc> | |
<lastmod>@(string.Format("{0:s}+00:00", node.UpdateDate))</lastmod> | |
</url> | |
} | |
if (node.Level <= 100 && node.Children.Count() > 0) | |
{ | |
@ListChildNodes(node) | |
} | |
} | |
} | |
@functions { | |
private static string GetUrlWithDomainPrefix(string url) | |
{ | |
if (url.StartsWith("/")) | |
url = url.Substring(1); | |
var domainPrefix = string.Format("http://{0}/", HttpContext.Current.Request.ServerVariables["HTTP_HOST"]); | |
if (url.StartsWith(domainPrefix)) | |
return url; | |
else | |
return domainPrefix + url; | |
} | |
} |
There is also an issue with the urls in the sitemap if your site uses https as opposed to http. This can be solved by amending the GetUrlWithDomainPrefix function as follows:
private static string GetUrlWithDomainPrefix(string url)
{
if (url.StartsWith("/"))
url = url.Substring(1);
if (url.StartsWith("http://"))
{
url = url.Replace("http://", "https://");
}
var domainPrefix = string.Format("https://{0}/", HttpContext.Current.Request.ServerVariables["HTTP_HOST"]);
if (url.StartsWith(domainPrefix))
return url;
else
return domainPrefix + url;
}
Useful script! Thanks for sharing. NB in Umbraco 7 we can use
node.UrlWithDomain()
and thus dispense with the GetUrlWithDomainPrefix() helper function.
In my case, I don't use a flag to exclude nodes from the sitemap, I do it by document type alias, as follows:
var docTypeExclusions = new List<string>()
{
"Basket", "Checkout", "Receipt", "etc"
};
foreach (var node in startNode.Children.Where(x => !x.DocumentTypeAlias.ContainsAny(docTypeExclusions)))
{ ... }
In Umbraco 6 there is NiceUrlWithDomain to bypass GetUrlWithDomainPrefix
Frequency: how to setup?
Excellent. Nice and simple and saved a lot of time. Thanks for sharing!
One typo - xsi:schemalocation should be xsi:schemaLocation
@jclementson: thanks - I've updated the Gist with xsi:schemaLocation
I was running into a problem where the view was adding an extra line at the beginning so that the xml declaration was on line 2, and thus invalid (getting the error "error on line 2 at column 6: XML declaration allowed only at the start of the document");
The fix that made it work for me was to write out the xml declaration in the response stream at the beginning of the view page. So the top looked like this instead:
@{
Response.Write("");
Response.ContentType = "text/xml";
Layout = null;
}
@inherits Umbraco.Web.Mvc.UmbracoTemplatePage
@using System.Linq;
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
@ListChildNodes(Umbraco.TypedContent(UmbracoContext.Current.PageId).AncestorOrSelf(1))
</urlset>
The suggestion to use node.UrlWithDomain()
by @BarryFogarty works well, and cleans up the code a good deal.
The change I made was to add two properties to most document types: ShowInXmlSitemap and ShowChildrenInXmlSitemap. if either of those properties is true, enter the for loop. if the first is true, output the current node. if the latter is true, loop through the child nodes. We defaulted the ShowInXmlSitemap to true for the non-xml sitemap document type you mentioned in your blog post.
This was necessary in our case because we have situations where we have a content page with several pieces of content under it, but they are merely rendered as content on the parent page. that allows us to disable the child content from producing their own sitemap nodes. In another case, we have a blog parent and both that page and all children should generate nodes.
This combination also helps with short circuiting how deeply the node inspection will go.
Thanks @alindgren for offering a great solution.
shouldn't be there also a record for the root site before
@ListChildNodes(Umbraco.TypedContent(UmbracoContext.Current.PageId).AncestorOrSelf(1))
?
right now it's starting from first child of the root, skipping the root itself
I have a site that has more than one "root"
so I put the sitemap in the root and modified the template with the following:
@foreach (var node in Umbraco.ContentAtRoot()) {
@GetUrlWithDomainPrefix(node.Url)
@(string.Format("{0:s}+00:00", node.UpdateDate))
}
instead of @ListChildNodes(Umbraco.TypedContent(UmbracoContext.Current.PageId).AncestorOrSelf(1))
thx, for the blog and code it was just what I needed.