Skip to main content

CWA Navigation Custom Tag

Image
By
Normally with Tridion, we do navigation as a transformation between a navigation XML with an XSLT stylesheet. We plug some parameters into this transformation in order to highlight the current context.

In CWA (Content Web Application) terms, this approach still applies only with some modification. Namely, the XML and XSLT are usually both published to the CD (Content Delivery) database. This setup implies that we need a special way or reading the XML/XSLT, prior to performing the actual transformation. To this respect, I created a custom Java tag CwaTransformXml that first ensures the XML and XSLT files are extracted from the CD DB and serialized as files on the file system, then second, it performs the XSLT transformation.

CwaTransformXml has the following attributes:
  • xml - the XML file path;
  • xslt - the XSLT file path;
  • paramName - the name of the parameter to pass into the transformation;
  • paramValue - the value of the parameter;
  • out - the variable name to set in PageContext holding the result of the transformation;

Moreover, the tag caches the XML DOM document and the XSLT Template into the application scope, such that they don't need be parsed and recreated with every tag call. Also the output of the transformation can be cached in the PageContext, such that it can be reused on the same page.

    <t:CwaTransformXml xml="/en/system/nav.xml" xslt="/en/system/main.xslt"
        paramName="CurrentPage" paramValue="tcm:2-3-64"/>

The main tag logic is the following:

public int doStartTag() throws JspException {
    try {
        Document xmlDom = (Document) CacheUtils.getFromCache(xml, pageContext, cache);
        DOMSource domSource = new DOMSource(xmlDom);
        Templates templates = (Templates) CacheUtils.getFromCache(xslt, pageContext, cache);

        Transformer transformer = templates.newTransformer();
        setParams(transformer);

        if (out == null) {
            transformer.transform(domSource, new StreamResult(pageContext.getOut()));
        } else {
            StringWriter writer = new StringWriter();
            transformer.transform(domSource, new StreamResult(writer));
            pageContext.setAttribute(out, writer.toString());
        }
    } catch (Exception e) {
        throw new JspException(e);
    }

    return SKIP_BODY;
}

The method CacheUtils.getFromCache() makes sure the path passed to it is retrieved from the CD DB and serialized to the file system (it is using CWA's class PageFileDistributionController), parses the XML DOM (or XSLT Templates object), places it into the application scope cache, then retrieves the actual DOM/Templates object.

public static Object getFromCache(String name, PageContext pageContext, long cache) {
    CacheEntry cacheEntry = (CacheEntry) pageContext.getAttribute(name,
        PageContext.APPLICATION_SCOPE);

    if (cacheEntry == null || System.currentTimeMillis() > cacheEntry.getTtl()) {
        cacheEntry = setInCache(name, cacheEntry, pageContext, cache);
    }

    return cacheEntry.getItem();
}

private static synchronized CacheEntry setInCache(String name, CacheEntry cacheEntry,
        PageContext pageContext, long cache) {
    long currentTimeMillis = System.currentTimeMillis();

    if (cacheEntry == null) {
        cacheEntry = new CacheEntry(0, null);
        pageContext.setAttribute(name, cacheEntry, PageContext.APPLICATION_SCOPE);
    }

    if (currentTimeMillis > cacheEntry.getTtl()) {
        PageFileDistributionController controller =
            PageFileDistributionController.getInstance();
        ServletContext servletContext = pageContext.getServletContext();
        HttpServletRequest request = (HttpServletRequest) pageContext.getRequest();
        File file = controller.processPage(servletContext, request, name);

        String nameLower = name.toLowerCase();
        Object item = null;
        if (nameLower.endsWith(".xslt") || nameLower.endsWith(".xsl")) {
            Source source = new StreamSource(file);
            item = transformerFactory.newTemplates(source);
        } else if (name.endsWith(".xml")) {
            DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
            item = documentBuilder.parse(file);
        }

        cacheEntry.setTtl(currentTimeMillis + cache);
        cacheEntry.setItem(item);
    }

    return cacheEntry;
}

Where CacheEntry class is just a POJO holding the following members:

    private long ttl;
    private Object item;

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