RecursiveMethod.UmbracoXmlParser 1.1.0-beta

Umbraco XML Parser

This repository contains code for a NuGet package that allows you to easily parse the Umbraco v4/v6/v7 XML cache file umbraco.config.

As of version 1.1.0-beta and later, support is also available for the Umbraco v8.0.1 (and later) NuCache DB format (eg. App_Data\TEMP\NuCache\NuCache.Content.db). Due to a binary format change, support for Umbraco v8.0.0 is not available.

These caches contains all published content and property data and can be used programmatically for any of the following purposes:

• Content migration (eg. migrate all published content elsewhere)
• Content analysis (eg. how many articles do not have a populated meta description property?)
• Content reporting (eg. how many published articles do we have this month?)

As of version 1.0.2 and later, Umbraco XML Parser understands the commonly used umbracoUrlAlias and umbracoUrlName elements to set the URL of the node in question. Note if the umbracoUrlAlias contains multiple aliases (comma separated), then only the first will be used as the URL.

Getting

Pull the package with nuget: install-package RecursiveMethod.UmbracoXmlParser

Using with Umbraco v4/v6/v7

Some sample LINQPad scripts.

Count all nodes of a certain doctype ("Article"):

var parser = new UmbracoXmlParser("umbraco.config");
var articleCount = parser.GetNodes().Where(n => n.Doctype == "Article").Count();
articleCount.Dump();

Dump all articles or reviews that do not have a meta description populated

var parser = new UmbracoXmlParser("umbraco.config");
var articles = parser.GetNodes().Where(n => (n.Doctype == "Article" || n.Doctype == "Review") &&
                                             string.IsNullOrWhiteSpace(n.GetPropertyAsString("metaDescription")));
articles.Dump();

Dump all nodes in the site with their node ID and URL, using a specific domain for the root level node (1069 in this case):

var parser = new UmbracoXmlParser("umbraco.config", new UmbracoParsingOptions
{
    UrlPrefixMapping = new Dictionary<int, string> { { 1069, "https://www.examplesite.com.au" } }
});
var articles = parser.GetNodes().Select(n => new { NodeId = n.Id, Url = n.Url });
articles.Dump();

Using with Umbraco v8.0.1 and later

Umbraco v8's NuCache format support is in beta. UmbracoXmlParser only includes support for the first property value and does not yet support getting property values for Segments or Cultures. The NuCache binary format itself does not include Document Type aliases nor usernames for creators or writers. But you can supply them using UmbracoParserOptions:

Count all nodes of a certain doctype ("Article"):

var parser = new UmbracoXmlParser("NuCache.content.db", new UmbracoParsingOptions
{
    DoctypeMapping = new Dictionary<int, string>
    {
        { 1095, "Article" },
        { 1096, "Review" }
    }
});
var articleCount = parser.GetNodes().Where(n => n.Doctype == "Article").Count();
articleCount.Dump();

Dump all articles or reviews that do not have a meta description populated

var parser = new UmbracoXmlParser("NuCache.content.db", new UmbracoParsingOptions
{
    DoctypeMapping = new Dictionary<int, string>
    {
        { 1095, "Article" },
        { 1096, "Review" }
    },
    UserMapping = new Dictionary<int, string>
    {
        { -1, "admin" },
        { 1278, "adam" }
    }
});
var articles = parser.GetNodes().Where(n => (n.Doctype == "Article" || n.Doctype == "Review") &&
                                             string.IsNullOrWhiteSpace(n.GetPropertyAsString("metaDescription")));
articles.Dump();

Dump all nodes in the site with their node UID, ID and URL, using a specific domain for the root level node (1095 in this case):

var parser = new UmbracoXmlParser("NuCache.content.db", new UmbracoParsingOptions
{
    UrlPrefixMapping = new Dictionary<int, string> { { 1095, "https://www.examplesite.com.au" } }
});
var articles = parser.GetNodes().Select(n => new { Uid = n.Uid, NodeId = n.Id, Url = n.Url });
articles.Dump();

More Info

See here.