Umbraco Hosting Tips: How to Use Courier to Deploy MultiType Data?

Umbraco Hosting Tips: How to Use Courier to Deploy MultiType Data?

When using Umbraco and doing production deployments with the courier package I suddenly met an issue. We’ve got had the process working fine with built in components but recently I deployed a new property that used the MultiType DataType which permits for arrays of data fields grouped together. For example we’ve got the following grouping and multiple images is added to the one parameter in Umbraco.

RotatingImages
Item
ImageSrc(Media Picker)
MobileSrc(Media Picker)
AltText(Text)
LinkTo(Content Picker)

The problem comes in when we publish this item, the content and media pickers contain the node id’s and the data is stored as XML. As such courier will not process the ID’s when it does the deployment process. To fix this a custom PropertyDataResolverProvider is needed. The following code can be included in the App_Code directory to fix this problem.

using Umbraco.Courier.Core;
using Umbraco.Courier.Core.Enums;
using Umbraco.Courier.Core.Helpers;
using Umbraco.Courier.DataResolvers;
using Umbraco.Courier.ItemProviders;

using System.Collections.Generic;
using System.Linq;

namespace JSP {
/// <summary>
/// Custm Data Resolver for use with MultiType data objects.  Will convers a list of xml nodes to guids for deployment and back again.
/// </summary>
public class MultiType : PropertyDataResolverProvider
{
    /// <summary>
    /// The datatype guid of the multitype item we are running on.
    /// </summary>
    public override Guid DataTypeId
    {
        get { return new Guid("f17bb230-3941-4813-a923-e7c3efd067d8"); }
    }

    /// <summary>
    /// Get the xpath elements from the data types that contain document or media id's.
    /// </summary>
    /// <param name="propertyData">Property to examin.</param>
    /// <param name="documentXPath">XPath string to select all fields with document ID's.</param>
    /// <param name="mediaXPath">XPath string to select all fields with media ID's.</param>
    private void GetXPath(ContentProperty propertyData, out string documentXPath, out string mediaXPath)
    {
        // Get the data definition for this item.
        var dataDefinition = new umbraco.cms.businesslogic.datatype.DataTypeDefinition(propertyData.DataType);
        
        // Get the item configureation and locate the preValue property.
        var preValue = umbraco.library.GetPreValues(dataDefinition.DataType.DataTypeDefinitionId);
        preValue.MoveNext();
        var preValueIterator = preValue.Current.SelectChildren("preValue", "");
        preValueIterator.MoveNext();

        // Deserialize the preValue data.
        dynamic data = new System.Web.Script.Serialization.JavaScriptSerializer().DeserializeObject(preValueIterator.Current.Value);
        // Get the MultiType Children properties.
        var mprop = ((object[])((Dictionary<string, object>)data)["MultiTypes"]).Cast<Dictionary<string, object>>();
        
        // Get all content picker properties and add the alias to the list.  Resutls: //Node1 | //Node2 | ...
        documentXPath = String.Join(" | ", mprop.Where(i => Convert.ToInt32(i["Type"]) == (int)_4Ben.DataTypes.MultiType.ControlType.ContentPicker).Select(i => "//" + i["Alias"].ToString()));
        // Get all media picker properties and add the alias to the list.  Resutls: //Node1 | //Node2 | ...
        mediaXPath = String.Join(" | ", mprop.Where(i => Convert.ToInt32(i["Type"]) == (int)_4Ben.DataTypes.MultiType.ControlType.MediaPicker).Select(i => "//" + i["Alias"].ToString()));
    }

    /// <summary>
    /// Run when a property of the specified type is packaged up.
    /// </summary>
    public override void PackagingProperty(Item item, ContentProperty propertyData)
    {
        string documentXpath;
        string mediaXpath;

        // Get the elements from this data type that need to be converted.  This could be hard coded but the queries are quick.
        GetXPath(propertyData, out documentXpath, out mediaXpath);

        // Document References
        List<string> replacedIds = new List<string>();
        propertyData.Value = XmlDependencies.ReplaceIds(propertyData.Value.ToString(), documentXpath, IdentifierReplaceDirection.FromNodeIdToGuid, out replacedIds);

        // List all id's found and make them dependencies.
        foreach (string guid in replacedIds)
        {
            // Add as a dependency. (working?)
            item.Dependencies.Add(guid, ProviderIDCollection.documentItemProviderGuid);
        }

        // Media References
        //dataXpath = ConfigurationManager.AppSettings["courierMultiTypeMediaNodes"].ToString();
        replacedIds = new List<string>();
        propertyData.Value = XmlDependencies.ReplaceIds(propertyData.Value.ToString(), mediaXpath, IdentifierReplaceDirection.FromNodeIdToGuid, out replacedIds);

        // List all id's found and make them dependencies.
        foreach (string guid in replacedIds)
        {
            // Add as a dependency. (working?)
            item.Dependencies.Add(guid, ProviderIDCollection.mediaItemProviderGuid);

            // Could add as a resource but in reality the entire node is needed witch wil transwer the resource so this line should not be run.
            //item.Resources.Add(new umbraco.cms.businesslogic.media.Media(new Guid(guid)).getProperty("umbracoFile").Value.ToString());
        }
    }

    /// <summary>
    /// Run when a property of the specified type is extracted.
    /// </summary>
    public override void ExtractingProperty(Item item, ContentProperty propertyData)
    {
        string documentXpath;
        string mediaXpath;

        // Get the elements from this data type that need to be converted.  This could be hard coded but the queries are quick.
        GetXPath(propertyData, out documentXpath, out mediaXpath);

        // Document References
        List<string> replacedIds = new List<string>();
        propertyData.Value = XmlDependencies.ReplaceIds(propertyData.Value.ToString(), documentXpath, IdentifierReplaceDirection.FromGuidToNodeId, out replacedIds);

        // Media References
        replacedIds = new List<string>();
        propertyData.Value = XmlDependencies.ReplaceIds(propertyData.Value.ToString(), mediaXpath, IdentifierReplaceDirection.FromGuidToNodeId, out replacedIds);

    }
}
}

Best Umbraco Hosting Recommendation

One of the most important things when choosing a good Umbraco hosting is the feature and reliability. HostForLIFE is the leading provider of Windows hosting and affordable Umbraco , their servers are optimized for PHP web applications such as the latest Umbraco version. The performance and the uptime of the Umbraco hosting service are excellent and the features of the web hosting plan are even greater than what many hosting providers ask you to pay for. At HostForLIFE.eu, customers can also experience fast Umbraco hosting. The company invested a lot of money to ensure the best and fastest performance of the datacenters, servers, network and other facilities. Its datacenters are equipped with the top equipments like cooling system, fire detection, high speed Internet connection, and so on. That is why HostForLIFE.eu guarantees 99.9% uptime for Umbraco. And the engineers do regular maintenance and monitoring works to assure its Umbraco hosting are security and always up.

hostforlifebanner