Автоматически HTML-кодирование вывода NVelocity (EventCartridge & ReferenceInsert)

Question

Я хотел попробовать заставить NVelocity автоматически кодировать HTML-код определенных строк в моем приложении MonoRail.

Я просмотрел исходный код NVelocity и нашел EventCartridge, который, кажется, класс, который вы можете подключить, чтобы изменить различные поведения.

В частности, этот класс имеет ReferenceInsert метод, который, кажется, делает именно то, что я хочу. Он в основном вызывается непосредственно перед тем, как значение ссылки (например, $ foobar) получает вывод, и позволяет вам изменять результаты.

Что я не могу понять, так это как настроить NVelocity/ механизм просмотра MonoRail NVelocity для использования моей реализации?

Документы Velocity предполагают, что speed.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
}

Answer 1

Попробуйте подключить новый EventCartridge к VelocityContext. Смотрите эти тесты в качестве ссылки.

Теперь, когда вы подтвердили, что этот подход работает, наследуйте от Castle.MonoRail.Framework.Views.NVelocity.NVelocityEngineпереопределить BeforeMerge и установить EventCartridge и событие там. Затем настройте MonoRail для использования этого пользовательского механизма просмотра.