Skip to main content

A DD4T.net Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component). This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries.

The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher. I therefore extended the BinaryPublisher and overrode method PublishItem.

public class CustomBinaryPublisher : BinaryPublisher
{
    private Template currentTemplate;
    private TcmUri structureGroupUri;

In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryContent.Filename.

In case there is a Structure Group specified, we use the AddBinary method that takes this into account.

protected override void PublishItem(Item item, TcmUri itemUri)
{
    string url;
    Stream stream = item.GetAsStream();
    RenderedItem renderedItem = engine.PublishingContext.RenderedItem;
    Component component = engine.GetObject(item.Properties["TCMURI"]) as Component;
    BinaryContent binaryContent = component.BinaryContent;
    string mimeType = binaryContent.MultimediaType.MimeType;
    string fileName = Path.GetFileName(binaryContent.Filename);

    if (string.IsNullOrEmpty(structureGroupUri))
    {
        url = renderedItem.AddBinary(stream, fileName, string.Empty, component, mimeType).Url;
    }
    else
    {
        StructureGroup structureGroup = engine.GetObject(structureGroupUri) as StructureGroup;
        url = renderedItem.AddBinary(stream, fileName, structureGroup, string.Empty, component, mimeType).Url;
    }

    item.Properties["PublishedPath"] = url;
}

A word of caution: the code above causes publishing to fail in case there are more than one Multimedia Components that contain a binary with the same name. This is because publishing the two Multimedia Components would in face result in the binaries being overwritten on disk.

The error will show up as "Phase: Deployment Prepare Commit Phase failed. Unable to prepare transaction" in the Publishing Queue. On a closer inspection, the core log on the Deployer side will show error "ProcessingException: Attempting to deploy a binary xxx to a location where a different binary is already stored Existing binary: yyy", which means exactly that -- a binary with id yyy is already published with the same name and in the same location as binary with id xxx currently being deployed.

However, this might not be an issue, if all Multimedia Components in the system have different file names (i.e. different binary file names).

The current custom binary publisher is however not used in this way. In a follow-up post, I will present a way to call the PublishItem method from a Template Building Block (TBB).



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