.net - 自动HTML编码NVelocity输出(EventCartridge和ReferenceInsert)

我想尝试让NVelocity自动对MonoRail应用程序中的某些字符串进行HTML编码。

我查看了NVelocity源代码，发现EventCartridge，它似乎是一个可以插入以更改各种行为的类。

特别是该类具有ReferenceInsert方法，该方法似乎完全可以实现我想要的功能。基本上在引用的值(例如$ foobar)输出之前，就可以调用它，并允许您修改结果。

我无法解决的是如何配置NVelocity / MonoRail NVelocity视图引擎以使用我的实现？

Velocity docs建议Velocity.properties可以包含一个条目，用于添加像这样的特定事件处理程序，但是在NVelocity源代码中找不到用于此配置的任何地方。

任何帮助，不胜感激!

编辑:显示此工作方式的简单测试(概念验证而不是生产代码!)

private VelocityEngine _velocityEngine;
private VelocityContext _velocityContext;

[SetUp]
public void Setup()
{
    _velocityEngine = new VelocityEngine();
    _velocityEngine.Init();

    // creates the context...
    _velocityContext = new VelocityContext();

    // attach a new event cartridge
    _velocityContext.AttachEventCartridge(new EventCartridge());

    // add our custom handler to the ReferenceInsertion event
    _velocityContext.EventCartridge.ReferenceInsertion += EventCartridge_ReferenceInsertion;
}

[Test]
public void EncodeReference()
{
    _velocityContext.Put("thisShouldBeEncoded", "<p>This \"should\" be 'encoded'</p>");

    var writer = new StringWriter();

    var result = _velocityEngine.Evaluate(_velocityContext, writer, "HtmlEncodingEventCartridgeTestFixture.EncodeReference", @"<p>This ""shouldn't"" be encoded.</p> $thisShouldBeEncoded");

    Assert.IsTrue(result, "Evaluation returned failure");
    Assert.AreEqual(@"<p>This ""shouldn't"" be encoded.</p> &lt;p&gt;This &quot;should&quot; be &#39;encoded&#39;&lt;/p&gt;", writer.ToString());
}

private static void EventCartridge_ReferenceInsertion(object sender, ReferenceInsertionEventArgs e)
{
    var originalString = e.OriginalValue as string;

    if (originalString == null) return;

    e.NewValue = HtmlEncode(originalString);
}

private static string HtmlEncode(string value)
{
    return value
        .Replace("&", "&amp;")
        .Replace("<", "&lt;")
        .Replace(">", "&gt;")
        .Replace("\"", "&quot;")
        .Replace("'", "&#39;"); // &apos; does not work in IE
}

最佳答案

尝试将新的EventCartridge附加到VelocityContext。请参阅these tests作为参考。

现在，您已经确认该方法有效，从Castle.MonoRail.Framework.Views.NVelocity.NVelocityEngine继承，覆盖BeforeMerge并在那里设置EventCartridge和event。然后将MonoRail配置为使用此自定义视图引擎。