Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature for turning off template path requirement #2722

Closed
wants to merge 2 commits into from
Closed

Feature for turning off template path requirement #2722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8dac416
Feature for turning off template path requirement
hcldan Feb 6, 2024
5e6e130
must update templates with ones registered from engine
hcldan Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions contrib/dyn_templates/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ rust-version = "1.75"
[features]
tera = ["tera_"]
handlebars = ["handlebars_"]
no_filesystem = []

[dependencies]
walkdir = "2.4"
Expand Down
133 changes: 78 additions & 55 deletions contrib/dyn_templates/src/context.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ pub(crate) type Callback =
Box<dyn Fn(&mut Engines) -> Result<(), Box<dyn Error>> + Send + Sync + 'static>;

pub(crate) struct Context {
#[cfg(not(feature = "no_filesystem"))]
/// The root of the template directory.
pub root: PathBuf,
/// Mapping from template name to its information.
Expand All @@ -26,73 +27,87 @@ impl Context {
/// template engine, and store all of the initialized state in a `Context`
/// structure, which is returned if all goes well.
pub fn initialize(root: &Path, callback: &Callback) -> Option<Context> {
fn is_file_with_ext(entry: &walkdir::DirEntry, ext: &str) -> bool {
let is_file = entry.file_type().is_file();
let has_ext = entry.path().extension().map_or(false, |e| e == ext);
is_file && has_ext
}

let root = match root.normalize() {
Ok(root) => root.into_path_buf(),
Err(e) => {
error!("Invalid template directory '{}': {}.", root.display(), e);
return None;
}
};

let mut templates: HashMap<String, TemplateInfo> = HashMap::new();
for &ext in Engines::ENABLED_EXTENSIONS {
for entry in walkdir::WalkDir::new(&root).follow_links(true) {
let entry = match entry {
Ok(entry) if is_file_with_ext(&entry, ext) => entry,
Ok(_) | Err(_) => continue,
};

let (name, data_type_str) = split_path(&root, entry.path());
if let Some(info) = templates.get(&*name) {
warn_!("Template name '{}' does not have a unique source.", name);
match info.path {
Some(ref path) => info_!("Existing path: {:?}", path),
None => info_!("Existing Content-Type: {}", info.data_type),
}

info_!("Additional path: {:?}", entry.path());
warn_!("Keeping existing template '{}'.", name);
continue;
}

let data_type = data_type_str.as_ref()
.and_then(|ext| ContentType::from_extension(ext))
.unwrap_or(ContentType::Text);

templates.insert(name, TemplateInfo {
path: Some(entry.into_path()),
engine_ext: ext,
data_type,
});
}
}


let mut engines = Engines::init(&templates)?;
if let Err(e) = callback(&mut engines) {
error_!("Template customization callback failed.");
error_!("{}", e);
return None;
}

for (name, engine_ext) in engines.templates() {
if !templates.contains_key(name) {
let data_type = Path::new(name).extension()
.and_then(|osstr| osstr.to_str())
.and_then(|ext| ContentType::from_extension(ext))
.unwrap_or(ContentType::Text);
fn update_templates(engines: &Engines, templates: &mut HashMap<String, TemplateInfo>) {
for (name, engine_ext) in engines.templates() {
if !templates.contains_key(name) {
let data_type = Path::new(name).extension()
.and_then(|osstr| osstr.to_str())
.and_then(|ext| ContentType::from_extension(ext))
.unwrap_or(ContentType::Text);

let info = TemplateInfo { path: None, engine_ext, data_type };
templates.insert(name.to_string(), info);
let info = TemplateInfo { path: None, engine_ext, data_type };
templates.insert(name.to_string(), info);
}
}
}

#[cfg(not(feature = "no_filesystem"))]
{
fn is_file_with_ext(entry: &walkdir::DirEntry, ext: &str) -> bool {
let is_file = entry.file_type().is_file();
let has_ext = entry.path().extension().map_or(false, |e| e == ext);
is_file && has_ext
}

let root = match root.normalize() {
Ok(root) => root.into_path_buf(),
Err(e) => {
error!("Invalid template directory '{}': {}.", root.display(), e);
return None;
}
};

for &ext in Engines::ENABLED_EXTENSIONS {
for entry in walkdir::WalkDir::new(&root).follow_links(true) {
let entry = match entry {
Ok(entry) if is_file_with_ext(&entry, ext) => entry,
Ok(_) | Err(_) => continue,
};

let (name, data_type_str) = split_path(&root, entry.path());
if let Some(info) = templates.get(&*name) {
warn_!("Template name '{}' does not have a unique source.", name);
match info.path {
Some(ref path) => info_!("Existing path: {:?}", path),
None => info_!("Existing Content-Type: {}", info.data_type),
}

info_!("Additional path: {:?}", entry.path());
warn_!("Keeping existing template '{}'.", name);
continue;
}

let data_type = data_type_str.as_ref()
.and_then(|ext| ContentType::from_extension(ext))
.unwrap_or(ContentType::Text);

templates.insert(name, TemplateInfo {
path: Some(entry.into_path()),
engine_ext: ext,
data_type,
});
}
}

update_templates(&engines, &mut templates);

Some(Context { root, templates, engines })
return Some(Context { root, templates, engines });
}

#[cfg(feature = "no_filesystem")]
{
update_templates(&engines, &mut templates);
return Some(Context { templates, engines });
}
}
}

Expand Down Expand Up @@ -140,8 +155,10 @@ mod manager {
}

impl ContextManager {
#[cfg(not(feature = "no_filesystem"))]
pub fn new(ctxt: Context) -> ContextManager {
let (tx, rx) = channel();

let watcher = recommended_watcher(tx).and_then(|mut watcher| {
watcher.watch(&ctxt.root.canonicalize()?, RecursiveMode::Recursive)?;
Ok(watcher)
Expand All @@ -160,6 +177,11 @@ mod manager {
ContextManager { watcher, context: RwLock::new(ctxt), }
}

#[cfg(feature = "no_filesystem")]
pub fn new(ctxt: Context) -> ContextManager {
ContextManager { watcher: None, context: RwLock::new(ctxt), }
}

pub fn context(&self) -> impl Deref<Target=Context> + '_ {
self.context.read().unwrap()
}
Expand All @@ -180,6 +202,7 @@ mod manager {
let templates_changes = self.watcher.as_ref()
.map(|(_, rx)| rx.lock().expect("fsevents lock").try_iter().count() > 0);

#[cfg(not(feature = "no_filesystem"))]
if let Some(true) = templates_changes {
info_!("Change detected: reloading templates.");
let root = self.context().root.clone();
Expand Down
1 change: 1 addition & 0 deletions contrib/dyn_templates/src/fairing.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ impl Fairing for TemplateFairing {
.expect("Template ContextManager registered in on_ignite");

info!("{}{}:", "📐 ".emoji(), "Templating".magenta());
#[cfg(not(feature = "no_filesystem"))]
info_!("directory: {}", Source::from(&*cm.context().root).primary());
info_!("engines: {:?}", Engines::ENABLED_EXTENSIONS.primary());
}
Expand Down
1 change: 1 addition & 0 deletions contrib/dyn_templates/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,7 @@ impl Template {
let ts: Vec<_> = ctxt.templates.keys().map(|s| s.as_str()).collect();
error_!("Template '{}' does not exist.", name);
info_!("Known templates: {}.", ts.join(", "));
#[cfg(not(feature = "no_filesystem"))]
info_!("Searched in {:?}.", ctxt.root);
Status::InternalServerError
})?;
Expand Down