Skip to main content

Enforce Anchor Target TBB

This week's TBB is Enforce Anchor Target TBB. The functionality is to enforce a 'system-wide' anchor target policy. Namely, any fully qualified URLs should open in a new (_blank) target browser window. All other (relative) URLs should open in the same target. More specifically, if there is a target specified for a relative URL, remove it.

Name
Enforce Anchor Target TBB
Type
·    Template in .NET Assembly
Description
Used to:
·    Enforces a certain “target” attribute for the anchor tags depending on their “href” attribute value;
Notes:
This generic TBB expects an Item called “Output” in the Package.
It parses the Output looking for anchor <a> tags. If the anchor’s “href” attribute is a fully qualified URL (starts with “http://” or “https://”), then it adds/replaces “target” attribute with value “_blank”. Otherwise, it removes the “target” attribute, if present.
Finally the transformed Output is saved back into the Package.
Parameters
n/a
Applicable to
Any template where an Item called ‘Output’ exists in the Package

The Code

[TcmTemplateTitle("Enforce Anchor Target TBB")]
public class EnforceAnchorTarget : ITemplate {

    private const string ANCHOR_REG_EXP = "<a[^>]*>";
    private readonly Regex imgRegExp = new Regex(ANCHOR_REG_EXP, RegexOptions.IgnoreCase);
    private readonly TemplatingLogger log = TemplatingLogger.GetLogger(typeof(EnforceAnchorTarget));

    public void Transform(Engine engine, Package package) {
        GenericUtils utils = new GenericUtils();
        Item outputItem = package.GetByName(Package.OutputName);
        string xhtml = outputItem.GetAsString();

        foreach (Match match in GetAnchorTags(xhtml)) {
            string anchorHtmlTag = match.Value;
            string anchorHref = utils.GetHtmlTagAttributeValue("href", anchorHtmlTag);
            if (anchorHref == null) // anchor without an href
            {
                continue;
            }

            string target = anchorHref.ToLower();
            if (target.StartsWith("http://") || target.StartsWith("https://")) {
                utils.SetHtmlTagAttribute("target", "_blank", ref anchorHtmlTag);
            } else {
                utils.RemoveHtmlTagAttribute("target", ref anchorHtmlTag);
            }

            xhtml = xhtml.Replace(match.Value, anchorHtmlTag);
        }

        outputItem.SetAsString(xhtml);
    }

    private MatchCollection GetAnchorTags(string xhtml) {
        return imgRegExp.Matches(xhtml);
    }
}


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...

REL Standard Tag Library

The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...

Publish Binaries to Mapped Structure Groups

Today's TBB of the Week comes from the high demand in the field to publish binary assets to different mapped Structure Groups. By default SDL Tridion offers two ways of publishing binaries: All binaries publish to a folder defined in your Publication properties; All binaries rendered by a given template publish to a folder corresponding to a given Structure Group; In my view, both cases are terrible, over-simplified and not representing a real use-case. Nobody in the field wants all binaries in one folder and nobody separates binary locations by template. Instead, everybody wants a mapping mechanism that takes a binary and publishes it to a given folder, defined by a Structure Group, and this mapping is done using some kind of metadata. More often than not, the metadata is the TCM Folder location of the Multimedia Component. I have seen this implemented numerous times. So the solution to publish binaries to a given location implies finding a mapping from a TCM Folder to a...