thymeleaf 0.1.0-beta.1

A framework-neutral Thymeleaf-compatible dynamic template engine for Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310

//! DTD 验证集成测试（`dtd-validation` feature）。
//!
//! 覆盖三部分：
//! 1. `DtdValidator` 单元：SYSTEM 标识符识别、未知标识符降级；
//! 2. `TemplateEngine` XML 模式三策略（Disabled / Warn / Strict）行为；
//! 3. DOCTYPE 缺失 / 未知 SYSTEM 标识符的边界语义。
#![cfg(feature = "dtd-validation")]

use std::sync::Arc;

use thymeleaf::context::Context;
use thymeleaf::dtd::ValidationPolicy;
use thymeleaf::templateresolver::StringTemplateResolver;
use thymeleaf::{TemplateEngine, TemplateMode};

const XHTML1_STRICT: &str = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";
const XHTML1_TRANSITIONAL: &str = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";
const XHTML1_FRAMESET: &str = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd";

/// 以给定 SYSTEM 标识符组装 `<!DOCTYPE html SYSTEM ...>` 前缀。
fn doctype(system_id: &str) -> String {
    format!("<!DOCTYPE html SYSTEM \"{system_id}\">\n")
}

/// XHTML 1.0 Strict 下合法的最小文档。
fn valid_strict() -> String {
    format!(
        "{}<html><head><title>t</title></head><body><p>x</p></body></html>",
        doctype(XHTML1_STRICT)
    )
}

/// 含未声明元素 `<bogus/>`（违反 Element Valid）。
fn invalid_undeclared_element() -> String {
    format!(
        "{}<html><head><title>t</title></head><body><p>x</p><bogus/></body></html>",
        doctype(XHTML1_STRICT)
    )
}

/// `html` 的内容模型为 `(head, body)`，缺 `head` 即违反。
fn invalid_missing_head() -> String {
    format!("{}<html><body/></html>", doctype(XHTML1_STRICT))
}

/// `p` 未声明 `bogusattr` 属性。
fn invalid_undeclared_attribute() -> String {
    format!(
        "{}<html><head><title>t</title></head><body><p bogusattr=\"1\">x</p></body></html>",
        doctype(XHTML1_STRICT)
    )
}

fn xml_engine(policy: ValidationPolicy) -> TemplateEngine {
    let engine = TemplateEngine::new();
    let mut resolver = StringTemplateResolver::new();
    resolver.set_template_mode(TemplateMode::XML);
    engine
        .set_template_resolver(Arc::new(resolver))
        .expect("engine not initialized");
    engine
        .set_dtd_validation_policy(policy)
        .expect("engine not initialized");
    engine
}

fn process(engine: &TemplateEngine, template: &str) -> Result<String, String> {
    let context = Context::new();
    engine
        .process_template(template, &context)
        .map(|output| output.to_string_lossy())
        .map_err(|error| {
            // 异常 Display 只含顶层消息，沿原因链拼接底层细节（含 DTD 违反描述）。
            let mut message = format!("{error}");
            let mut source = std::error::Error::source(&*error);
            while let Some(current) = source {
                message.push_str(" | ");
                message.push_str(&current.to_string());
                source = current.source();
            }
            message
        })
}

#[test]
fn disabled_policy_is_default_and_never_rejects() {
    assert_eq!(ValidationPolicy::default(), ValidationPolicy::Disabled);
    // 默认引擎（未显式设置策略）对无效文档放行——零验证开销语义。
    let engine = xml_engine(ValidationPolicy::Disabled);
    for template in [
        invalid_undeclared_element(),
        invalid_missing_head(),
        invalid_undeclared_attribute(),
    ] {
        let result = process(&engine, &template);
        assert!(result.is_ok(), "Disabled must not reject: {result:?}");
    }
}

#[test]
fn strict_accepts_valid_document() {
    let engine = xml_engine(ValidationPolicy::Strict);
    let output = process(&engine, &valid_strict()).expect("valid document must pass");
    assert!(output.contains("<p>x</p>"), "unexpected output: {output}");
}

#[test]
fn strict_accepts_mixed_content_nodes() {
    let engine = xml_engine(ValidationPolicy::Strict);
    // 注释/PI 按 markup() 处理（非 EMPTY 内容即合法）；实体引用与 CDATA
    // 按 reference_data 处理（p 为混合内容模型，均放行）。
    let template = format!(
        concat!(
            "{}<html><head><title>t<!-- note --><?proc instr?></title></head>",
            "<body><p>a&amp;b<![CDATA[<c>]]></p></body></html>"
        ),
        doctype(XHTML1_STRICT)
    );
    let result = process(&engine, &template);
    assert!(result.is_ok(), "mixed content must pass Strict: {result:?}");
}

#[test]
fn strict_rejects_text_in_empty_element() {
    let engine = xml_engine(ValidationPolicy::Strict);
    // XHTML 1.0 Strict 中 <base> 声明为 EMPTY：任何字符数据即违反。
    let template = format!(
        concat!(
            "{}<html><head><title>t</title><base href=\"/\">x</base></head>",
            "<body><p>x</p></body></html>"
        ),
        doctype(XHTML1_STRICT)
    );
    let error = process(&engine, &template).expect_err("text in EMPTY element must fail");
    assert!(
        error.contains("DTD validation failed"),
        "error must identify DTD validation: {error}"
    );
}

#[test]
fn strict_rejects_undeclared_element() {
    let engine = xml_engine(ValidationPolicy::Strict);
    let error = process(&engine, &invalid_undeclared_element())
        .expect_err("undeclared element must fail in Strict");
    assert!(
        error.contains("DTD validation failed"),
        "error must identify DTD validation: {error}"
    );
    assert!(
        error.to_lowercase().contains("bogus"),
        "error must name the offending element: {error}"
    );
}

#[test]
fn strict_rejects_missing_head_content_model() {
    let engine = xml_engine(ValidationPolicy::Strict);
    let error =
        process(&engine, &invalid_missing_head()).expect_err("missing head must fail in Strict");
    assert!(
        error.contains("DTD validation failed"),
        "error must identify DTD validation: {error}"
    );
}

#[test]
fn strict_rejects_undeclared_attribute() {
    let engine = xml_engine(ValidationPolicy::Strict);
    let error = process(&engine, &invalid_undeclared_attribute())
        .expect_err("undeclared attribute must fail in Strict");
    assert!(
        error.contains("DTD validation failed"),
        "error must identify DTD validation: {error}"
    );
}

#[test]
fn warn_validates_but_never_rejects() {
    let engine = xml_engine(ValidationPolicy::Warn);
    for template in [
        invalid_undeclared_element(),
        invalid_missing_head(),
        invalid_undeclared_attribute(),
    ] {
        let result = process(&engine, &template);
        assert!(result.is_ok(), "Warn must not reject: {result:?}");
    }
}

#[test]
fn strict_without_doctype_skips_validation() {
    let engine = xml_engine(ValidationPolicy::Strict);
    // 无 DOCTYPE 即无验证义务：未声明元素不构成违反。
    let result = process(&engine, "<html><body><bogus/></body></html>");
    assert!(result.is_ok(), "no DOCTYPE means no validation: {result:?}");
}

#[test]
fn strict_with_unknown_system_id_fails_closed() {
    let engine = xml_engine(ValidationPolicy::Strict);
    let template = format!(
        "{}<html><body><bogus/></body></html>",
        doctype("http://example.com/unknown.dtd")
    );
    let error = process(&engine, &template).expect_err("unresolvable DTD must fail in Strict");
    assert!(
        error.contains("Cannot resolve DTD"),
        "error must identify unresolvable DTD: {error}"
    );
}

#[test]
fn warn_with_unknown_system_id_degrades_to_no_validation() {
    let engine = xml_engine(ValidationPolicy::Warn);
    let template = format!(
        "{}<html><body><bogus/></body></html>",
        doctype("http://example.com/unknown.dtd")
    );
    let result = process(&engine, &template);
    assert!(
        result.is_ok(),
        "Warn must degrade to no validation: {result:?}"
    );
}

#[test]
fn validator_builds_for_all_versioned_system_ids() {
    use thymeleaf::dtd::DtdValidator;
    // Thymeleaf 命名空间：4 族 × 4 版本 = 16 个，全部必须可解析。
    for family in [
        "xhtml1-strict",
        "xhtml1-transitional",
        "xhtml1-frameset",
        "xhtml11",
    ] {
        for version in ["1", "2", "3", "4"] {
            let system_id =
                format!("http://www.thymeleaf.org/dtd/{family}-thymeleaf-{version}.dtd");
            let declaration = format!("html SYSTEM \"{system_id}\"");
            assert!(
                DtdValidator::new(&declaration).is_some(),
                "versioned system id must resolve: {system_id}"
            );
        }
    }
    // W3C 命名空间：4 个标准 URL（含 xhtml11——jar 自包含单体）。
    for system_id in [
        XHTML1_STRICT,
        XHTML1_TRANSITIONAL,
        XHTML1_FRAMESET,
        "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd",
    ] {
        let declaration = format!("html SYSTEM \"{system_id}\"");
        assert!(
            DtdValidator::new(&declaration).is_some(),
            "W3C system id must resolve: {system_id}"
        );
    }
    let unknown = "html SYSTEM \"http://example.com/x.dtd\"";
    assert!(DtdValidator::new(unknown).is_none());
    // 未声明外部标识符的声明主体按内部子集 DTD 解析，仍可构建。
    assert!(DtdValidator::new("html").is_some());
}

#[test]
fn validator_accepts_transitional_typo_aliases() {
    use thymeleaf::dtd::DtdValidator;
    // transitional 族文件头自引用的历史拼写（`transitonal`，缺 i）：
    // Thymeleaf 2 时代模板可能照抄进 DOCTYPE，防御性注册必须生效。
    for version in ["1", "2", "3", "4"] {
        let system_id =
            format!("http://www.thymeleaf.org/dtd/xhtml1-transitonal-thymeleaf-{version}.dtd");
        let declaration = format!("html SYSTEM \"{system_id}\"");
        assert!(
            DtdValidator::new(&declaration).is_some(),
            "typo alias must resolve: {system_id}"
        );
    }
}

#[test]
fn strict_validates_xhtml11_document() {
    let engine = xml_engine(ValidationPolicy::Strict);
    // XHTML 1.1 文档：此前 W3C 官方分体版在离线环境解析失败会失败关闭；
    // 换用 jar 自包含单体后必须端到端可验证。
    let template = format!(
        "{}<html><head><title>t</title></head><body><p>x</p></body></html>",
        doctype("http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd")
    );
    let output = process(&engine, &template).expect("xhtml11 document must pass Strict");
    assert!(output.contains("<p>x</p>"), "unexpected output: {output}");
}

#[test]
fn strict_validates_transitional_doctype() {
    let engine = xml_engine(ValidationPolicy::Strict);
    // Transitional 允许 Strict 禁止的元素（如 <center>），对 Transitional 应放行。
    let template = format!(
        "{}<html><head><title>t</title></head><body><center>x</center></body></html>",
        doctype(XHTML1_TRANSITIONAL)
    );
    let result = process(&engine, &template);
    assert!(result.is_ok(), "transitional allows center: {result:?}");
    // 同一文档对 Strict 必须拒绝——DOCTYPE 决定验证基准。
    let engine = xml_engine(ValidationPolicy::Strict);
    let strict_template = template.replace(XHTML1_TRANSITIONAL, XHTML1_STRICT);
    let error = process(&engine, &strict_template).expect_err("strict must reject center");
    assert!(error.contains("DTD validation failed"), "{error}");
}