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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
use std::borrow::Cow;
use std::collections::BTreeMap;
use std::fmt;
use std::sync::Arc;
use serde::Serialize;
use crate::compiler::codegen::CodeGenerator;
use crate::compiler::lexer::SyntaxConfig;
use crate::compiler::parser::parse_expr;
use crate::error::{attach_basic_debug_info, Error, ErrorKind};
use crate::expression::Expression;
use crate::output::Output;
use crate::template::{CompiledTemplate, Template};
use crate::utils::{AutoEscape, BTreeMapKeysDebug, UndefinedBehavior};
use crate::value::{FunctionArgs, FunctionResult, Value};
use crate::vm::{State, Vm};
use crate::{defaults, filters, functions, tests};
type TemplateMap<'source> = BTreeMap<&'source str, Arc<CompiledTemplate<'source>>>;
#[derive(Clone)]
enum Source<'source> {
Borrowed(TemplateMap<'source>, SyntaxConfig),
#[cfg(feature = "source")]
Owned(crate::source::Source),
}
impl<'source> fmt::Debug for Source<'source> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Borrowed(tmpls, _) => fmt::Debug::fmt(&BTreeMapKeysDebug(tmpls), f),
#[cfg(feature = "source")]
Self::Owned(arg0) => fmt::Debug::fmt(arg0, f),
}
}
}
type AutoEscapeFunc = dyn Fn(&str) -> AutoEscape + Sync + Send;
type FormatterFunc = dyn Fn(&mut Output, &State, &Value) -> Result<(), Error> + Sync + Send;
/// An abstraction that holds the engine configuration.
///
/// This object holds the central configuration state for templates. It is also
/// the container for all loaded templates.
///
/// The environment holds references to the source the templates were created from.
/// This makes it very inconvenient to pass around unless the templates are static
/// strings.
#[cfg_attr(
feature = "source",
doc = "
For situations where you want to load dynamic templates and share the
environment it's recommended to turn on the `source` feature and to use the
[`Source`](crate::source::Source) type with the environment."
)]
///
/// There are generally two ways to construct an environment:
///
/// * [`Environment::new`] creates an environment preconfigured with sensible
/// defaults. It will contain all built-in filters, tests and globals as well
/// as a callback for auto escaping based on file extension.
/// * [`Environment::empty`] creates a completely blank environment.
#[derive(Clone)]
pub struct Environment<'source> {
templates: Source<'source>,
filters: BTreeMap<Cow<'source, str>, filters::BoxedFilter>,
tests: BTreeMap<Cow<'source, str>, tests::BoxedTest>,
pub(crate) globals: BTreeMap<Cow<'source, str>, Value>,
default_auto_escape: Arc<AutoEscapeFunc>,
undefined_behavior: UndefinedBehavior,
formatter: Arc<FormatterFunc>,
#[cfg(feature = "debug")]
debug: bool,
#[cfg(feature = "fuel")]
fuel: Option<u64>,
}
impl<'source> Default for Environment<'source> {
fn default() -> Self {
Environment::empty()
}
}
impl<'source> fmt::Debug for Environment<'source> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Environment")
.field("globals", &self.globals)
.field("tests", &BTreeMapKeysDebug(&self.tests))
.field("filters", &BTreeMapKeysDebug(&self.filters))
.field("templates", &self.templates)
.finish()
}
}
impl<'source> Environment<'source> {
/// Creates a new environment with sensible defaults.
///
/// This environment does not yet contain any templates but it will have all
/// the default filters, tests and globals loaded. If you do not want any
/// default configuration you can use the alternative
/// [`empty`](Environment::empty) method.
pub fn new() -> Environment<'source> {
Environment {
templates: Source::Borrowed(Default::default(), Default::default()),
filters: defaults::get_builtin_filters(),
tests: defaults::get_builtin_tests(),
globals: defaults::get_globals(),
default_auto_escape: Arc::new(defaults::default_auto_escape_callback),
undefined_behavior: UndefinedBehavior::default(),
formatter: Arc::new(defaults::escape_formatter),
#[cfg(feature = "debug")]
debug: cfg!(debug_assertions),
#[cfg(feature = "fuel")]
fuel: None,
}
}
/// Creates a completely empty environment.
///
/// This environment has no filters, no templates, no globals and no default
/// logic for auto escaping configured.
pub fn empty() -> Environment<'source> {
Environment {
templates: Source::Borrowed(Default::default(), Default::default()),
filters: Default::default(),
tests: Default::default(),
globals: Default::default(),
default_auto_escape: Arc::new(defaults::no_auto_escape),
undefined_behavior: UndefinedBehavior::default(),
formatter: Arc::new(defaults::escape_formatter),
#[cfg(feature = "debug")]
debug: cfg!(debug_assertions),
#[cfg(feature = "fuel")]
fuel: None,
}
}
/// Loads a template from a string.
///
/// The `name` parameter defines the name of the template which identifies
/// it. To look up a loaded template use the [`get_template`](Self::get_template)
/// method.
///
/// Note that there are situations where the interface of this method is
/// too restrictive. For instance the environment itself does not permit
/// any form of sensible dynamic template loading.
#[cfg_attr(
feature = "source",
doc = "To address this restriction use [`set_source`](Self::set_source)."
)]
pub fn add_template(&mut self, name: &'source str, source: &'source str) -> Result<(), Error> {
match self.templates {
Source::Borrowed(ref mut map, ref syntax) => {
let compiled_template = ok!(CompiledTemplate::from_name_and_source_with_syntax(
name,
source,
syntax.clone()
));
map.insert(name, Arc::new(compiled_template));
Ok(())
}
#[cfg(feature = "source")]
Source::Owned(ref mut src) => src.add_template(name, source),
}
}
/// Removes a template by name.
pub fn remove_template(&mut self, name: &str) {
match self.templates {
Source::Borrowed(ref mut map, _) => {
map.remove(name);
}
#[cfg(feature = "source")]
Source::Owned(ref mut source) => {
source.remove_template(name);
}
}
}
/// Fetches a template by name.
///
/// This requires that the template has been loaded with
/// [`add_template`](Environment::add_template) beforehand. If the template was
/// not loaded an error of kind `TemplateNotFound` is returned.
///
/// ```
/// # use minijinja::{Environment, context};
/// let mut env = Environment::new();
/// env.add_template("hello.txt", "Hello {{ name }}!").unwrap();
/// let tmpl = env.get_template("hello.txt").unwrap();
/// println!("{}", tmpl.render(context!{ name => "World" }).unwrap());
/// ```
pub fn get_template(&self, name: &str) -> Result<Template<'_>, Error> {
let compiled = match &self.templates {
Source::Borrowed(ref map, _) => {
ok!(map.get(name).ok_or_else(|| Error::new_not_found(name)))
}
#[cfg(feature = "source")]
Source::Owned(source) => ok!(source.get_compiled_template(name)),
};
Ok(Template::new(
self,
compiled,
self.initial_auto_escape(name),
))
}
/// Parses and renders a template from a string in one go.
///
/// In some cases you really only need a template to be rendered once from
/// a string and returned. The internal name of the template is `<string>`.
///
/// ```
/// # use minijinja::{Environment, context};
/// let env = Environment::new();
/// let rv = env.render_str("Hello {{ name }}", context! { name => "World" });
/// println!("{}", rv.unwrap());
/// ```
///
/// **Note on values:** The [`Value`] type implements `Serialize` and can be
/// efficiently passed to render. It does not undergo actual serialization.
pub fn render_str<S: Serialize>(&self, source: &str, ctx: S) -> Result<String, Error> {
// reduce total amount of code faling under mono morphization into
// this function, and share the rest in _eval.
self._render_str("<string>", source, Value::from_serializable(&ctx))
}
/// Parses and renders a template from a string in one go with name.
///
/// Like [`render_str`](Self::render_str), but provide a name for the
/// template to be used instead of the default `<string>`.
///
/// ```
/// # use minijinja::{Environment, context};
/// let env = Environment::new();
/// let rv = env.render_named_str(
/// "template_name",
/// "Hello {{ name }}",
/// context! { name => "World" }
/// );
/// println!("{}", rv.unwrap());
/// ```
///
/// **Note on values:** The [`Value`] type implements `Serialize` and can be
/// efficiently passed to render. It does not undergo actual serialization.
pub fn render_named_str<S: Serialize>(
&self,
name: &str,
source: &str,
ctx: S,
) -> Result<String, Error> {
// reduce total amount of code faling under mono morphization into
// this function, and share the rest in _eval.
self._render_str(name, source, Value::from_serializable(&ctx))
}
fn _render_str(&self, name: &str, source: &str, root: Value) -> Result<String, Error> {
let compiled = ok!(CompiledTemplate::from_name_and_source_with_syntax(
name,
source,
self._syntax_config().clone()
));
let mut rv = String::with_capacity(compiled.buffer_size_hint);
Vm::new(self)
.eval(
&compiled.instructions,
root,
&compiled.blocks,
&mut Output::with_string(&mut rv),
self.initial_auto_escape(name),
)
.map(|_| rv)
}
/// Sets a new function to select the default auto escaping.
///
/// This function is invoked when templates are loaded from the environment
/// to determine the default auto escaping behavior. The function is
/// invoked with the name of the template and can make an initial auto
/// escaping decision based on that. The default implementation
/// ([`default_auto_escape_callback`](defaults::default_auto_escape_callback))
/// turn on escaping depending on the file extension.
///
/// ```
/// # use minijinja::{Environment, AutoEscape};
/// # let mut env = Environment::new();
/// env.set_auto_escape_callback(|name| {
/// if matches!(name.rsplit('.').next().unwrap_or(""), "html" | "htm" | "aspx") {
/// AutoEscape::Html
/// } else {
/// AutoEscape::None
/// }
/// });
/// ```
pub fn set_auto_escape_callback<F>(&mut self, f: F)
where
F: Fn(&str) -> AutoEscape + 'static + Sync + Send,
{
self.default_auto_escape = Arc::new(f);
}
/// Changes the undefined behavior.
///
/// This changes the runtime behavior of [`undefined`](Value::UNDEFINED) values in
/// the template engine. For more information see [`UndefinedBehavior`]. The
/// default is [`UndefinedBehavior::Lenient`].
pub fn set_undefined_behavior(&mut self, behavior: UndefinedBehavior) {
self.undefined_behavior = behavior;
}
/// Returns the current undefined behavior.
///
/// This is particularly useful if a filter function or similar wants to change its
/// behavior with regards to undefined values.
#[inline(always)]
pub fn undefined_behavior(&self) -> UndefinedBehavior {
self.undefined_behavior
}
/// Sets a different formatter function.
///
/// The formatter is invoked to format the given value into the provided
/// [`Output`]. The default implementation is
/// [`escape_formatter`](defaults::escape_formatter).
///
/// When implementing a custom formatter it depends on if auto escaping
/// should be supported or not. If auto escaping should be supported then
/// it's easiest to just wrap the default formatter. The
/// following example swaps out `None` values before rendering for
/// `Undefined` which renders as an empty string instead.
///
/// The current value of the auto escape flag can be retrieved directly
/// from the [`State`].
///
/// ```
/// # use minijinja::Environment;
/// # let mut env = Environment::new();
/// use minijinja::escape_formatter;
/// use minijinja::value::Value;
///
/// env.set_formatter(|out, state, value| {
/// escape_formatter(
/// out,
/// state,
/// if value.is_none() {
/// &Value::UNDEFINED
/// } else {
/// value
/// },
/// )
///});
/// # assert_eq!(env.render_str("{{ none }}", ()).unwrap(), "");
/// ```
pub fn set_formatter<F>(&mut self, f: F)
where
F: Fn(&mut Output, &State, &Value) -> Result<(), Error> + 'static + Sync + Send,
{
self.formatter = Arc::new(f);
}
/// Enable or disable the debug mode.
///
/// When the debug mode is enabled the engine will dump out some of the
/// execution state together with the source information of the executing
/// template when an error is created. The cost of this is relatively
/// high as the data including the template source is cloned.
///
/// When this is enabled templates will print debug information with source
/// context when the error is printed.
///
/// This requires the `debug` feature. This is enabled by default if
/// debug assertions are enabled and false otherwise.
#[cfg(feature = "debug")]
#[cfg_attr(docsrs, doc(cfg(feature = "debug")))]
pub fn set_debug(&mut self, enabled: bool) {
self.debug = enabled;
}
/// Returns the current value of the debug flag.
#[cfg(feature = "debug")]
pub fn debug(&self) -> bool {
self.debug
}
/// Sets the optional fuel of the engine.
///
/// When MiniJinja is compiled with the `fuel` feature then every
/// instruction consumes a certain amount of fuel. Usually `1`, some will
/// consume no fuel. By default the engine has the fuel feature disabled
/// (`None`). To turn on fuel set something like `Some(50000)` which will
/// allow 50.000 instructions to execute before running out of fuel.
///
/// Fuel consumed per-render.
#[cfg(feature = "fuel")]
#[cfg_attr(docsrs, doc(cfg(feature = "fuel")))]
pub fn set_fuel(&mut self, fuel: Option<u64>) {
self.fuel = fuel;
}
/// Returns the configured fuel.
#[cfg(feature = "fuel")]
#[cfg_attr(docsrs, doc(cfg(feature = "fuel")))]
pub fn fuel(&self) -> Option<u64> {
self.fuel
}
/// Sets the syntax for the environment.
///
/// Note that when `source` is used, the syntax is held on the underlying source
/// which means that the actual source needs to have it's syntax changed.
///
/// See [`Syntax`](crate::Syntax) for more information.
#[cfg(feature = "custom_syntax")]
#[cfg_attr(docsrs, doc(cfg(feature = "custom_syntax")))]
pub fn set_syntax(&mut self, syntax: crate::custom_syntax::Syntax) -> Result<(), Error> {
match self.templates {
Source::Borrowed(_, ref mut syn) => *syn = ok!(syntax.compile()),
#[cfg(feature = "source")]
Source::Owned(ref mut source) => ok!(source.set_syntax(syntax)),
};
Ok(())
}
/// Returns the current syntax.
#[cfg(feature = "custom_syntax")]
#[cfg_attr(docsrs, doc(cfg(feature = "custom_syntax")))]
pub fn syntax(&self) -> &crate::custom_syntax::Syntax {
&self._syntax_config().syntax
}
fn _syntax_config(&self) -> &SyntaxConfig {
match self.templates {
Source::Borrowed(_, ref syn) => syn,
#[cfg(feature = "source")]
Source::Owned(ref source) => source._syntax_config(),
}
}
/// Sets the template source for the environment.
///
/// This helps when working with dynamically loaded templates. The
/// [`Source`](crate::source::Source) is consulted by the environment to
/// look up templates that are requested. The source has the capabilities
/// to load templates with fewer lifetime restrictions and can also
/// load templates dynamically at runtime as requested.
///
/// When a source is set already loaded templates in the environment are
/// discarded and replaced with the templates from the source.
///
/// For more information see [`Source`](crate::source::Source).
#[cfg(feature = "source")]
#[cfg_attr(docsrs, doc(cfg(feature = "source")))]
pub fn set_source(&mut self, source: crate::source::Source) {
self.templates = Source::Owned(source);
}
/// Returns the currently set source.
#[cfg(feature = "source")]
#[cfg_attr(docsrs, doc(cfg(feature = "source")))]
pub fn source(&self) -> Option<&crate::source::Source> {
match self.templates {
Source::Borrowed(..) => None,
Source::Owned(ref source) => Some(source),
}
}
/// Returns the currently set source as mutable reference.
#[cfg(feature = "source")]
#[cfg_attr(docsrs, doc(cfg(feature = "source")))]
pub fn source_mut(&mut self) -> Option<&mut crate::source::Source> {
match self.templates {
Source::Borrowed(..) => None,
Source::Owned(ref mut source) => Some(source),
}
}
/// Compiles an expression.
///
/// This lets one compile an expression in the template language and
/// receive the output. This lets one use the expressions of the language
/// be used as a minimal scripting language. For more information and an
/// example see [`Expression`].
pub fn compile_expression(&self, expr: &'source str) -> Result<Expression<'_, 'source>, Error> {
attach_basic_debug_info(self._compile_expression(expr), expr)
}
fn _compile_expression(&self, expr: &'source str) -> Result<Expression<'_, 'source>, Error> {
let ast = ok!(parse_expr(expr, self._syntax_config().clone()));
let mut gen = CodeGenerator::new("<expression>", expr);
gen.compile_expr(&ast);
let (instructions, _) = gen.finish();
Ok(Expression::new(self, instructions))
}
/// Adds a new filter function.
///
/// Filter functions are functions that can be applied to values in
/// templates. For details about filters have a look at
/// [`Filter`](crate::filters::Filter).
pub fn add_filter<N, F, Rv, Args>(&mut self, name: N, f: F)
where
N: Into<Cow<'source, str>>,
// the crazy bounds here exist to enable borrowing in closures
F: filters::Filter<Rv, Args>
+ for<'a> filters::Filter<Rv, <Args as FunctionArgs<'a>>::Output>,
Rv: FunctionResult,
Args: for<'a> FunctionArgs<'a>,
{
self.filters
.insert(name.into(), filters::BoxedFilter::new(f));
}
/// Removes a filter by name.
pub fn remove_filter(&mut self, name: &str) {
self.filters.remove(name);
}
/// Adds a new test function.
///
/// Test functions are similar to filters but perform a check on a value
/// where the return value is always true or false. For details about tests
/// have a look at [`Test`](crate::tests::Test).
pub fn add_test<N, F, Rv, Args>(&mut self, name: N, f: F)
where
N: Into<Cow<'source, str>>,
// the crazy bounds here exist to enable borrowing in closures
F: tests::Test<Rv, Args> + for<'a> tests::Test<Rv, <Args as FunctionArgs<'a>>::Output>,
Rv: tests::TestResult,
Args: for<'a> FunctionArgs<'a>,
{
self.tests.insert(name.into(), tests::BoxedTest::new(f));
}
/// Removes a test by name.
pub fn remove_test(&mut self, name: &str) {
self.tests.remove(name);
}
/// Adds a new global function.
///
/// For details about functions have a look at [`functions`]. Note that
/// functions and other global variables share the same namespace.
/// For more details about functions have a look at
/// [`Function`](crate::functions::Function).
pub fn add_function<N, F, Rv, Args>(&mut self, name: N, f: F)
where
N: Into<Cow<'source, str>>,
// the crazy bounds here exist to enable borrowing in closures
F: functions::Function<Rv, Args>
+ for<'a> functions::Function<Rv, <Args as FunctionArgs<'a>>::Output>,
Rv: FunctionResult,
Args: for<'a> FunctionArgs<'a>,
{
self.add_global(name.into(), Value::from_function(f))
}
/// Adds a global variable.
pub fn add_global<N, V>(&mut self, name: N, value: V)
where
N: Into<Cow<'source, str>>,
V: Into<Value>,
{
self.globals.insert(name.into(), value.into());
}
/// Removes a global function or variable by name.
pub fn remove_global(&mut self, name: &str) {
self.globals.remove(name);
}
/// Looks up a function.
pub(crate) fn get_global(&self, name: &str) -> Option<Value> {
self.globals.get(name).cloned()
}
/// Looks up a filter.
pub(crate) fn get_filter(&self, name: &str) -> Option<&filters::BoxedFilter> {
self.filters.get(name)
}
/// Looks up a test function.
pub(crate) fn get_test(&self, name: &str) -> Option<&tests::BoxedTest> {
self.tests.get(name)
}
pub(crate) fn initial_auto_escape(&self, name: &str) -> AutoEscape {
(self.default_auto_escape)(name)
}
/// Formats a value into the final format.
///
/// This step is called finalization in Jinja2 but since we are writing into
/// the output stream rather than converting values, it's renamed to format
/// here.
pub(crate) fn format(
&self,
value: &Value,
state: &State,
out: &mut Output,
) -> Result<(), Error> {
if value.is_undefined() && matches!(self.undefined_behavior, UndefinedBehavior::Strict) {
Err(Error::from(ErrorKind::UndefinedError))
} else {
(self.formatter)(out, state, value)
}
}
}