Skip to main content

A DD4T.net Implementation - Navigation

Most of the websites I have worked on already existed before upgrading them to DD4T. This means the navigation has already been implemented, usually as means of publishing an XML file from Tridion (most always called navigation.xml ;-) ), and then rendered dynamically at request time by means of XSLT transformation.

This setup makes it quite easy to implement navigation in DD4T. I always try to reuse what I have, and the existing navigation.xml is a perfect candidate. We can reuse the Tridion template and Template Building Block that generates the navigation without any modification.

The generated navigation.xml can be even published to file-system, so other parts of the website can still use it. Alternatively, we can store it in the Content Delivery DB.

The approach for generating navigation in DD4T relies in creating an object model from the navigation XML by deserialization, then caching it for faster performance. Everything is wrapped inside a singleton factory wired through Ninject (or whatever other dependency injection framework you happen to use), and voilà -- you've got navigation.

Object Model

First we need a model to hold the navigation objects. We have the navigation XML, which usually represents a structure of very similar nested nodes.

<root>
  <nav uri="tcm:1-2-4" title="Root" url="/default.aspx">
    <nav uri="tcm:1-3-4" title="Products" url="/products/default.aspx">
      <nav uri="tcm:1-4-64" title="Product 1" url="/products/product-1.aspx"/>
      <nav uri="tcm:1-5-64" title="Product 2" url="/products/product-2.aspx"/>

We need to create model classes with properties for each attribute in the XML. Luckily, Visual Studio has already a tool that does that automatically -- xsd.exe.

C:\Temp>xsd navigation.xml
Microsoft (R) Xml Schemas/DataTypes support utility
[Microsoft (R) .NET Framework, Version 4.0.30319.33440]
Copyright (C) Microsoft Corporation. All rights reserved.
Writing file 'C:\Temp\navigation.xsd'.

C:\Temp>xsd navigation.xsd /classes
Microsoft (R) Xml Schemas/DataTypes support utility
[Microsoft (R) .NET Framework, Version 4.0.30319.33440]
Copyright (C) Microsoft Corporation. All rights reserved.
Writing file 'C:\Temp\navigation.cs'.

The execution of the xsd.exe program above generates model class navigation.cs, which after some beautification, looks something like this:

using System.Xml.Serialization;

public partial class nav
{
    private nav[] nav1Field;
    private string uriField;
    private string titleField;
    private string urlField;

    [XmlElementAttribute("nav")]
    public nav[] nav1
    {
        get { return this.nav1Field; }
        set { this.nav1Field = value; }
    }

    [XmlAttributeAttribute()]
    public string uri
    {
        get { return this.uriField; }
        set { this.uriField = value; }
    }

    [XmlAttributeAttribute()]
    public string title
    {
        get { return this.titleField; }
        set { this.titleField = value; }
    }

    [XmlAttributeAttribute()]
    public string url
    {
        get { return this.urlField; }
        set { this.urlField = value; }
    }
}

And after some more beautification, the code looks like this (note that I added property ParentItem and marked it ignorable while deserialization -- this will hold a reference to the parent navigation item):

using System.Xml.Serialization;

[XmlRoot(Namespace = "", ElementName = "root", IsNullable = false)]
public partial class Navigation
{
    [XmlElement("nav")]
    public NavigationItem[] Items { get; set; }
}

[XmlRoot(Namespace = "", IsNullable = false)]
public partial class NavigationItem
{
    [XmlElement("nav")]
    public NavigationItem[] ChildItems { get; set; }

    [XmlIgnore]
    public NavigationItem ParentItem { get; set; }

    [XmlAttribute("uri")]
    public string Uri { get; set; }

    [XmlAttribute("title")]
    public string Title { get; set; }

    [XmlAttribute("url")]
    public string Url { get; set; }
}

Deserialization

Next, we need to deserialize the XML into our model class. The method below performs the deserialization of an XML navigation file. Similar code could be used to deserialize a String representing navigation XML coming from the database.

private T ParseXml<T>(string filePath) where T : class
{
    try
    {
        using (XmlReader reader = XmlReader.Create(filePath,
            new XmlReaderSettings() { ConformanceLevel = ConformanceLevel.Document }))
        {
            return new XmlSerializer(typeof(T)).Deserialize(reader) as T;
        }
    }
    catch (IOException ioe)
    {
        LOG.Error("Can't read navigation file " + filePath, ioe);
        return null;
    }
}

The ParseXml method is to be called from the NavigationFactory, but more about that in a follow-up post.

    Navigation navigation = ParseXML<Navigation>(navigationFilePath);

Check out the follow-up post Navigation (part 2) for a showcase of the NavigationFactory and a way of creating a fully-linked navigation object model.


Comments

Popular posts from this blog

Toolkit - Dynamic Content Queries

This post if part of a series about the  File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine . The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached. Query Class This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterio

A DD4T.net Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component) . This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries. The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher . I therefore extended the BinaryPublisher and overrode method PublishItem. public class CustomBinaryPublisher : BinaryPublisher { private Template currentTemplate; private TcmUri structureGroupUri; In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryConten

Scaling Policies

This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the