/// <summary>
/// Render the provided template in a new context with the specified parameters.
/// </summary>
/// <param name="inputTemplate"></param>
/// <param name="parameters">The settings applied to the rendering process.</param>
/// <returns>
/// A LavaRenderResult object, containing the rendered output of the template or any errors encountered during the rendering process.
/// </returns>
public static LavaRenderResult RenderTemplate(string inputTemplate, LavaRenderParameters parameters)
{
if (_engine == null)
{
return(null);
}
// If this template is being rendered as part of a web page handler, ensure that the cache key includes a reference
// to the associated Rock theme. This is necessary because Lava templates that include references
// to theme assets may appear identical, but will render differently if the asset content is different for each theme.
// For example, the template "{% include '~~/Assets/Lava/template.lava' %} will produce different output if the content
// of the "template.lava" file is different for each theme.
var page = HttpContext.Current?.Handler as RockPage;
if (page != null)
{
string cacheKey;
if (string.IsNullOrEmpty(parameters.CacheKey))
{
cacheKey = _engine.TemplateCacheService.GetCacheKeyForTemplate(inputTemplate);
}
else
{
cacheKey = parameters.CacheKey;
}
parameters.CacheKey = GetWebTemplateCacheKey(cacheKey, page.Site?.Theme);
}
return(_engine.RenderTemplate(inputTemplate, parameters));
}
/// <summary>
/// Process the specified input template and return the result.
/// </summary>
/// <param name="inputTemplate"></param>
/// <returns></returns>
public LavaRenderResult GetTemplateRenderResult(ILavaEngine engine, string inputTemplate, LavaRenderParameters parameters = null, LavaTestRenderOptions options = null)
{
inputTemplate = inputTemplate ?? string.Empty;
var context = engine.NewRenderContext();
if (parameters == null)
{
parameters = LavaRenderParameters.WithContext(context);
}
// If options are specified, replace the render parameters.
if (options != null)
{
context.SetEnabledCommands(options.EnabledCommands, options.EnabledCommandsDelimiter);
context.SetMergeFields(options.MergeFields);
if (options.ExceptionHandlingStrategy != null)
{
parameters.ExceptionHandlingStrategy = options.ExceptionHandlingStrategy;
}
}
var result = engine.RenderTemplate(inputTemplate.Trim(), parameters);
return(result);
}
/// <summary>
/// Process the specified input template and return the result.
/// </summary>
/// <param name="inputTemplate"></param>
/// <returns></returns>
public string GetTemplateOutput(ILavaEngine engine, string inputTemplate, ILavaRenderContext context)
{
inputTemplate = inputTemplate ?? string.Empty;
var result = engine.RenderTemplate(inputTemplate.Trim(), LavaRenderParameters.WithContext(context));
return(result.Text);
}
/// <summary>
/// Process the specified input template and return the result.
/// </summary>
/// <param name="inputTemplate"></param>
/// <returns></returns>
public string GetTemplateOutput(ILavaEngine engine, string inputTemplate, LavaDataDictionary mergeFields = null)
{
inputTemplate = inputTemplate ?? string.Empty;
var result = engine.RenderTemplate(inputTemplate.Trim(), mergeFields);
return(result.Text);
}
private LavaRenderResult ExecuteSqlBlock(ILavaEngine engine, string lavaScript)
{
var renderContext = engine.NewRenderContext(new List <string> {
"Sql"
});
var result = engine.RenderTemplate(lavaScript,
new LavaRenderParameters {
Context = renderContext, ExceptionHandlingStrategy = ExceptionHandlingStrategySpecifier.RenderToOutput
});
return(result);
}
private static void AssertTemplateResult(string expected, string template)
{
// Tests in this class are only compatible with the DotLiquid engine.
// If/when these tests are reworked for the Fluid engine, they should be moved to the Rock.Tests.UnitTests.Lava namespace.
if (_lavaEngine == null)
{
_lavaEngine = LavaService.NewEngineInstance(typeof(global::Rock.Lava.DotLiquid.DotLiquidEngine), new LavaEngineConfigurationOptions());
}
var result = _lavaEngine.RenderTemplate(template);
Assert.That.AreEqual(expected, result.Text);
}
/// <summary>
/// Verify that the specified template is invalid.
/// </summary>
/// <param name="inputTemplate"></param>
/// <returns></returns>
public void AssertTemplateIsInvalid(ILavaEngine engine, string inputTemplate, LavaDataDictionary mergeFields = null)
{
inputTemplate = inputTemplate ?? string.Empty;
Assert.That.ThrowsException <LavaException>(
() =>
{
var renderOptions = new LavaRenderParameters
{
Context = engine.NewRenderContext(mergeFields),
ExceptionHandlingStrategy = ExceptionHandlingStrategySpecifier.Throw
};
_ = engine.RenderTemplate(inputTemplate.Trim(), renderOptions);
},
"Invalid template expected.");
}
/// <summary>
/// Process the specified input template and return the result.
/// </summary>
/// <param name="inputTemplate"></param>
/// <returns></returns>
public string GetTemplateOutput(ILavaEngine engine, string inputTemplate, LavaRenderParameters renderParameters)
{
inputTemplate = inputTemplate ?? string.Empty;
if (engine == null)
{
throw new Exception("Engine instance is required.");
}
var result = engine.RenderTemplate(inputTemplate.Trim(), renderParameters);
if (result.HasErrors)
{
throw result.Error;
}
return(result.Text);
}
/// <summary>
/// Process the specified input template and return the result.
/// </summary>
/// <param name="inputTemplate"></param>
/// <returns></returns>
public string GetTemplateOutput(ILavaEngine engine, string inputTemplate, LavaTestRenderOptions options)
{
inputTemplate = inputTemplate ?? string.Empty;
var context = engine.NewRenderContext();
var parameters = LavaRenderParameters.WithContext(context);
if (options != null)
{
context.SetEnabledCommands(options.EnabledCommands, options.EnabledCommandsDelimiter);
context.SetMergeFields(options.MergeFields);
parameters.ExceptionHandlingStrategy = options.ExceptionHandlingStrategy;
}
var result = engine.RenderTemplate(inputTemplate.Trim(), parameters);
return(result.Text);
}
/// <summary>
/// Renders the specified context.
/// </summary>
/// <param name="context">The context.</param>
/// <param name="result">The result.</param>
public override void OnRender(ILavaRenderContext context, TextWriter result)
{
if (_shortcode == null)
{
result.Write($"An error occurred while processing the {0} shortcode.", _tagName);
}
// Get the parameters and default values defined by the shortcode, then apply the parameters that have been specified in the shortcode tag attributes
// and those that are stored in the current render context.
var parms = new Dictionary <string, object>();
foreach (var shortcodeParm in _shortcode.Parameters)
{
parms.AddOrReplace(shortcodeParm.Key, shortcodeParm.Value);
}
SetParametersFromElementAttributes(parms, _elementAttributesMarkup, context);
// Set a unique id for the shortcode.
parms.AddOrReplace("uniqueid", "id-" + Guid.NewGuid().ToString());
// Apply the merge fields in the block context.
var internalMergeFields = context.GetMergeFields();
foreach (var item in parms)
{
internalMergeFields.AddOrReplace(item.Key, item.Value);
}
// Add parameters for tracking the recursion depth.
int currentRecursionDepth = 0;
if (parms.ContainsKey("RecursionDepth"))
{
currentRecursionDepth = parms["RecursionDepth"].ToString().AsInteger() + 1;
if (currentRecursionDepth > _maxRecursionDepth)
{
result.Write("A recursive loop was detected and processing of this shortcode has stopped.");
return;
}
}
parms.AddOrReplace("RecursionDepth", currentRecursionDepth);
// Resolve the merge fields in the shortcode template in a separate context, using the set of merge fields that have been modified by the shortcode parameters.
// Apply the set of enabled commands specified by the shortcode definition, or those enabled for the current context if none are defined by the shortcode.
// The resulting content is a shortcode template that is ready to be processed to resolve its child elements.
var enabledCommands = _shortcode.EnabledLavaCommands ?? new List <string>();
enabledCommands = enabledCommands.Where(x => !string.IsNullOrWhiteSpace(x)).ToList();
if (!enabledCommands.Any())
{
enabledCommands = context.GetEnabledCommands();
}
var shortcodeTemplateContext = _engine.NewRenderContext(internalMergeFields, enabledCommands);
var blockMarkupRenderResult = _engine.RenderTemplate(_blockMarkup.ToString(), LavaRenderParameters.WithContext(shortcodeTemplateContext));
var shortcodeTemplateMarkup = blockMarkupRenderResult.Text;
// Extract child elements from the shortcode template content.
// One or more child elements can be added to a shortcode block using the syntax "[[ <childElementName> <paramName1>:value1 <paramName2>:value2 ... ]] ... [[ end<childElementName> ]]",
// where <childElementName> is a shortcode-specific tag name, <param1> is a shortcode parameter name, and <value1> is the parameter value.
// Child elements are grouped by <childElementName>, and each collection is passed as a separate parameter to the shortcode template
// using the variable name "<childElementNameItems>". The first element of the array is also added using the variable name "<childElementName>".
// Parameters declared on child elements can be referenced in the shortcode template as <childElementName>.<paramName>.
Dictionary <string, object> childElements;
var residualMarkup = ExtractShortcodeBlockChildElements(shortcodeTemplateMarkup, out childElements);
// Add the collections of child to the set of parameters that will be passed to the shortcode template.
foreach (var item in childElements)
{
parms.AddOrReplace(item.Key, item.Value);
}
// Set context variables related to the block content so they can be referenced by the shortcode template.
if (residualMarkup.IsNotNullOrWhiteSpace())
{
// JME (7/23/2019) Commented out the two lines below and substituted the line after to allow for better
// processing of the block content. Testing was done on all existing shortcodes but leaving
// this code in place in case a future edge case is found. Could/should remove this in the future.
// Regex rgx = new Regex( @"{{\s*blockContent\s*}}", RegexOptions.IgnoreCase );
// lavaTemplate = rgx.Replace( lavaTemplate, blockMarkup );
parms.AddOrReplace("blockContent", residualMarkup);
parms.AddOrReplace("blockContentExists", true);
}
else
{
parms.AddOrReplace("blockContentExists", false);
}
// Now ensure there aren't any entity commands in the block that are not allowed.
// This is necessary because the shortcode may be configured to allow more entities for processing
// than the source block, template, action, etc. permits.
var securityCheckResult = _engine.RenderTemplate(residualMarkup, LavaRenderParameters.WithContext(context));
Regex securityErrorPattern = new Regex(string.Format(Constants.Messages.NotAuthorizedMessage, ".*"));
Match securityErrorMatch = securityErrorPattern.Match(securityCheckResult.Text);
// If the security check failed, return the error message.
if (securityErrorMatch.Success)
{
result.Write(securityErrorMatch.Value);
return;
}
// Merge the shortcode template in a new context, using the parameters and security allowed by the shortcode.
var shortcodeContext = _engine.NewRenderContext(parms);
// If the shortcode specifies a set of enabled Lava commands, set these for the current context.
// If not, use the commands enabled for the current context.
if (_shortcode.EnabledLavaCommands != null &&
_shortcode.EnabledLavaCommands.Any())
{
shortcodeContext.SetEnabledCommands(_shortcode.EnabledLavaCommands);
}
else
{
shortcodeContext.SetEnabledCommands(context.GetEnabledCommands());
}
var results = _engine.RenderTemplate(_shortcode.TemplateMarkup, LavaRenderParameters.WithContext(shortcodeContext));
result.Write(results.Text.Trim());
}