Skip to main content

Resolve JS Images In Output TBB

Image
By
The TBB of this week is Resolve JS Images In Output, originally written by my colleague Eric Huiza. Basically, the TBB does what the name says. It looks for certain images in the Output item and publishes them.

The images have to be in TcmUri or WebDAV format and they must appear in the url('path') format. This is the format that a CSS background selector uses, for example, only that it appears in JavaScript.

The TB transforms something like:

document.getElementById(openingTitleId).style.background=
    "url('/webdav/Content/Building Blocks/Assets/images/titlebar.gif') no-repeat";

into this:

document.getElementById(openingTitleId).style.background=
    "url('/assets/images/titlebar_tcm1-2.gif') no-repeat";

Description

Name
Resolve JS Images In Output TBB
Type
·    Template in .NET Assembly
Description
Used to:
·    Resolve references to Multimedia Components TcmUris or WebDAV URLs inside JS syntax;
·    Publishe the MMC and replaces the TcmUri/WebDAV reference with the resolved URL;
Notes:
This generic TBB uses the Output item to search for references to MMC TcmUris (or WebDav URLs) inside JavaScript references to CSS ‘background’ selectors.
If such MMC TcmUri is identified, the MMC is published (to the mapped Structure Group) and the returned URL replaces the TcmUri reference.
The Output item is rewritten with the resolved URLs.
Parameters
n/a
Applicable to
Any template where an Item called ‘Output’ exists in the Package

Code

[TcmTemplateTitle("Resolve JS Images In Output TBB")]
public class ResolveJsImagesInOutput : ITemplate {

    public const string JS_IMG_REG_EX = @"(url[\s]*\([\s]*(?<url>[^\)]*)[\s]*\))+";
    public readonly Regex cssBgRegEx = new Regex(JS_IMG_REG_EX, RegexOptions.IgnoreCase);

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

        foreach (Match match in GetUrlEntities(js)) {
            string uri = match.Groups["url"].Value.Replace("\"", string.Empty).Replace("'", string.Empty);
            string localUri = utils.LocalizeUri(engine, uri);
            Component imgComponent = engine.GetObject(localUri) as Component;
            if (imgComponent != null) {
                Binary binary = utils.PublishBinary(engine, package, imgComponent);
                js = js.Replace(uri, binary.Url);
            }
        }

        outputItem.SetAsString(js);
    }

    private IEnumerable<Match> GetUrlEntities(string js) {
        return cssBgRegEx.Matches(js).Cast<Match>().
            Where(w => w.Groups["url"].Value.StartsWith("\"/webdav") ||
                w.Groups["url"].Value.StartsWith("'/webdav") ||
                w.Groups["url"].Value.StartsWith("\"tcm:") ||
                w.Groups["url"].Value.StartsWith("'tcm:"));
    }
}

where the util.LocalizeUri method is the following:

public string LocalizeUri(Engine engine, string tcmUri) {
    if (TcmUri.IsValid(tcmUri)) {
        return engine.LocalizeUri(new TcmUri(tcmUri));
    } else {
        return tcmUri;
    }
}


Labels:

Comments

Post a Comment

Popular posts from this blog

Running sp_updatestats on AWS RDS database

By
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...
2 comments
Read more

REL Standard Tag Library

By
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...
2 comments
Read more

Publish Binaries to Mapped Structure Groups

By Unknown
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...
10 comments
Read more