Skip to main content

A DD4T.net Implementation - Extending the LinkFactory

In my current DD4T .net implementation, I encountered the requirement of having Rich Text Format fields resolved in a custom way. Namely, I had to check whether the type of a RTF Component link is of a wrapper around the actual Component to link to, and if so, resolve the link to the wrapped Component.

An elegant way of doing to is to extend the default DD4T.ContentModel.Factories.LinkFactory and create a new method ResolveRTFLink(string componentUri):

public interface IMyLinkFactory : ILinkFactory
{
    string ResolveRTFLink(string componentUri);
}

The implementing class would extend DD4T LinkFactory and implement IMyLinkFactory:

public class MyLinkFactory : LinkFactory, IMyLinkFactory
{
    [Inject]
    public virtual IComponentFactory ComponentFactory { get; set; }

    [Inject]
    public virtual IModelFactory ModelFactory { get; set; }

At the same time the class must provide an implementation for ResolveRTFLink method:

public string ResolveRTFLink(string componentUri)
{
    string key = string.Format("Link_{0}", componentUri);
    string link = (string)CacheAgent.Load(key);

    if (link == null)
    {
        link = GetRTFUrl(componentUri);
        if (link == null)
        {
            return ResolveLink(componentUri);
        }
        CacheAgent.Store(key, "Link", link);
    }

    return "UnresolvedLink".Equals(link) ? null : link;
}

private string GetRTFUrl(string componentUri)
{
    ModelBase model = ModelFactory.TryGetModel<ModelBase>(componentUri);
    // custom logic to resolve link to 'model'

    return resolvedLink;
}

The mapping of interface to factory singleton instance is specified using Ninject, in class DD4TNinjectModule.cs:

Bind<IMyLinkFactory>().ToMethod(context => new MyLinkFactory()
{
    LinkProvider = context.Kernel.Get<IMyLinkProvider>()
}).InSingletonScope();

Next, we need to call the method ResolveRTFLink. We do this from a helper class that I shamelessly copied from the DD4T libraries. The only modification is to call my own custom resolve method. As you can see this is an extension method for class string:

public static MvcHtmlString ResolveRichText(this string value)
{
    XmlDocument document = new XmlDocument();
    XmlNamespaceManager namespaceManager = new XmlNamespaceManager(document.NameTable);
    namespaceManager.AddNamespace("xhtml", XHTML_NAMESPACE_URI);
    namespaceManager.AddNamespace("xlink", XLINK_NAMESPACE_URI);
    document.LoadXml(string.Format("<xhtmlroot>{0}</xhtmlroot>", value));

    foreach (XmlNode node in document.SelectNodes("//xhtml:a[@xlink:href[starts-with(string(.),'tcm:')]][@xhtml:href='' or not(@xhtml:href)]", namespaceManager))
    {
        string componentUri = node.Attributes["xlink:href"].Value;
        string url = LinkFactory.ResolveRTFLink(componentUri);

        if (string.IsNullOrEmpty(url))
        {
            foreach (XmlNode childNode in node.ChildNodes)
            {
                node.ParentNode.InsertBefore(childNode.CloneNode(true), node);
            }
            node.ParentNode.RemoveChild(node);
        }
        else
        {
            XmlAttribute href = document.CreateAttribute("xhtml:href");
            href.Value = url;
            node.Attributes.Append(href);
            foreach (XmlAttribute attribute in node.SelectNodes("//@xlink:*", namespaceManager))
            {
                node.Attributes.Remove(attribute);
            }
        }
    }

    foreach (XmlNode node in document.SelectNodes("//*[@xlink:*]", namespaceManager))
    {
        foreach (XmlAttribute attribute in node.SelectNodes("//@xlink:*", namespaceManager))
        {
            node.Attributes.Remove(attribute);
        }
    }

    return new MvcHtmlString(RemoveNamespaceReferences(document.DocumentElement.InnerXml));
}

Finally, all I'm left to do is to call the string extension method whenever resolving an RTF field is required. Namely, this is done in one place only -- in extension methods in class IFieldSetExtenstionMethods.cs as described in post IFieldSet Extension Methods:

public static IList<string> ResolveRichTexts(this IFieldSet fieldSet, string fieldName)
{
    return StringValues(fieldSet, fieldName).Select(x => x.ResolveRichText().ToString()).ToList();
}

public static string ResolveRichText(this IFieldSet fieldSet, string fieldName)
{
    string value = StringValues(fieldSet, fieldName).FirstOrDefault<string>();
    return value == null ? null : value.ResolveRichText().ToString();
}



Comments

Popular posts from this blog

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Debugging a Tridion 2011 Event System

OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven