Skip to main content

Toolkit - Dynamic Linking

This post if part of a series about the File System Toolkit - a custom content delivery API for SDL Tridion.

In this post I describe the dynamic link resolving logic as part of the Link Factory.

There are three types of links: Component, Page and Binary links. Each of these links can be resolved using the Link Factory.

Component Link

Resolving a Component link implies finding the URL of the Page the target Component appears on. Using the current Toolkit models, it is quite straight forward to retrieve the URL, because the link information is contained within the Component model.

However, there might be several potential links available when performing Component link resolving. Namely, there can be several cases possible:
  • there is no linking information available in the Component model -- this means the link cannot be resolved (i.e. there is no Page published that contains the given Component);
  • there is exactly one Page available that contains the Component -- this means we retrieve the Page URL and return it as the link;
  • there are several potential Pages available that contain the Component -- in this case we need to pick one page only according to the following algorithm: 
    • take the Page that contains the Component with the highest link priority. If there are more than one pages possible, then go to next step;
    • take the Page relatively closest to the Page where the link is displayed on. The relative distance is the number of folders one page is away from the other. If there are more than one pages possible, then go to next step;
    • take the page that was published the latest;
You might notice that in order for the algorithm to work, we must provide the current Page -- this is the page where the link is displayed on. Without this page, we cannot identify accurately the relatively closest potential page.

public Link getComponentLink(TcmUri pageUri, TcmUri componentUri) {
    LinkImpl result = new LinkImpl();
    ComponentMeta componentMeta = modelFactory.getModel(componentUri);
    List<LinkInfo> linkInfos = componentMeta.getLinkInfos();
    if (linkInfos == null || linkInfos.size() == 0) {
        return result;
    }

    String[] urlParts;
    PageMeta pageMeta = modelFactory.getModel(pageUri);
    if (pageMeta == null) {
        urlParts = new String[0];
    } else {
        urlParts = pageMeta.getUrl().split("/");
    }

    int pageId = pageUri.getItemId();
    int maxPriority = 1;
    int minDistance = Integer.MAX_VALUE;
    List<LinkInfo> filteredInfos = new ArrayList<>();

    for (LinkInfo linkInfo : linkInfos) {
        if (linkInfo.getPage() != pageId) {
            int distance = getDistance(urlParts, linkInfo.getUrl());
            int priority = linkInfo.getPriority();
            if (priority > maxPriority) {
                maxPriority = priority;
                minDistance = distance;
                filteredInfos.clear();
            } else if (distance < minDistance) {
                minDistance = distance;
                filteredInfos.clear();
            }
            if (priority == maxPriority && distance == minDistance) {
                filteredInfos.add(linkInfo);
            }
        }
    }

    LinkInfo linkInfo = getLastPublished(filteredInfos);
    if (linkInfo != null) {
        result.setResolved(true);
        result.setUrl(linkInfo.getUrl());
        result.setTargetUri(new TcmUri(componentUri.getPublicationId(),
                linkInfo.getPage(), ItemTypes.PAGE));
    }

    return result;
}

Below are the two helper methods getDistance between two paths and getLastPublished date out of a collection of Pages.

private int getDistance(String[] parts, String url) {
    int result = 0;

    String[] parts2 = url.split("/");
    int n = Math.min(parts.length, parts2.length) - 1;
    int i = 0;
    boolean loop = true;

    for (; i < n && loop; i++) {
        if (!parts[i].equals(parts2[i])) {
            loop = false;
            i--;
        }
    }

    result += parts.length - i - 1;
    result += parts2.length - i - 1;

    return result;
}

private LinkInfo getLastPublished(List<LinkInfo> linkInfos) {
    switch (linkInfos.size()) {
        case 0:
            return null;

        case 1:
            return linkInfos.get(0);

        default:
            long maxPublished = 0;
            LinkInfo result = linkInfos.get(0);

            for (LinkInfo linkInfo : linkInfos) {
                TcmUri metaUri = new TcmUri(linkInfo.getPublication(), linkInfo.getPage(), ItemTypes.PAGE);
                PageMeta pageMeta = modelFactory.getModel(metaUri);
                if (pageMeta != null) {
                    long lastPublished = pageMeta.getLastPublished().getTime();
                    if (lastPublished > maxPublished) {
                        maxPublished = lastPublished;
                        result = linkInfo;
                    }
                }
            }

            return result;
    }
}

Page Links

Resolving a page link implies retrieving the Page model by TcmUri and returning its URL.

public Link getPageLink(TcmUri pageUri) {
    LinkImpl result = new LinkImpl();
    PageMeta pageMeta = modelFactory.getModel(pageUri);
    if (pageMeta == null) {
        return result;
    }

    result.setResolved(true);
    result.setUrl(pageMeta.getUrl());
    result.setTargetUri(pageMeta.getTcmUri());

    return result;
}

Binary Links

Resolving a binary link implies retrieving the Multimedia Component model and retrieving its link information URL. Binaries can be published using different variants, so we can either identify a link by its variant or, in the absence of a variant, simply serve the first link available.

public Link getBinaryLink(TcmUri binaryUri, String variant) {
    LinkImpl result = new LinkImpl();
    ComponentMeta binaryMeta = modelFactory.getModel(binaryUri);
    if (binaryMeta == null) {
        return result;
    }

    if (!binaryMeta.isMultimedia()) {
        return result;
    }

    List<LinkInfo> linkInfos = binaryMeta.getLinkInfos();
    if (linkInfos == null || linkInfos.size() == 0) {
        return result;
    }

    variant = variant == null ? "" : variant;

    for (LinkInfo linkInfo : linkInfos) {
        String linkVariant = linkInfo.getVariant();
        linkVariant = linkVariant == null ? "" : linkVariant;
        if (variant.equals(linkVariant)) {
            result.setResolved(true);
            result.setUrl(linkInfo.getUrl());
            result.setTargetUri(binaryUri);
            break;
        }
    }

    return result;
}



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