Use tera safe filters

Kixiron · Kixiron · commit 1ad3d4e5b73b · 2020-08-11T18:38:18.000-05:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -60,7 +60,7 @@ staticfile = { version = "0.4", features = ["cache"] }
 tempfile = "3.1.0"
 
 # Templating
-tera = { version = "1.3.1", features = ["builtins"] }
+tera = { version = "1.5.0", features = ["builtins"] }
 walkdir = "2"
 
 # Template hot-reloading
diff --git a/src/web/page/templates.rs b/src/web/page/templates.rs
@@ -149,6 +149,9 @@ pub(super) fn load_templates(conn: &mut Client) -> Result<Tera> {
     tera.register_filter("timeformat", timeformat);
     tera.register_filter("dbg", dbg);
     tera.register_filter("dedent", dedent);
+    tera.register_filter("fas", IconType::Strong);
+    tera.register_filter("far", IconType::Regular);
+    tera.register_filter("fab", IconType::Brand);
 
     Ok(tera)
 }
@@ -252,6 +255,43 @@ fn dedent(value: &Value, _args: &HashMap<String, Value>) -> TeraResult<Value> {
     ))
 }
 
+enum IconType {
+    Strong,
+    Regular,
+    Brand,
+}
+
+impl fmt::Display for IconType {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let icon = match self {
+            Self::Strong => "fas",
+            Self::Regular => "far",
+            Self::Brand => "fab",
+        };
+
+        f.write_str(icon)
+    }
+}
+
+impl tera::Filter for IconType {
+    fn filter(&self, value: &Value, args: &HashMap<String, Value>) -> TeraResult<Value> {
+        let icon = format!(
+            r#"<span class="{} fa-{}" aria-hidden="true" {}></span>"#,
+            self,
+            value.as_str().expect("Icons only take strings"),
+            args.get("extra")
+                .and_then(Value::as_str)
+                .unwrap_or_default(),
+        );
+
+        Ok(Value::String(icon))
+    }
+
+    fn is_safe(&self) -> bool {
+        true
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
diff --git a/templates/about-base.html b/templates/about-base.html
@@ -6,23 +6,23 @@
             <h3 id="crate-title">Docs.rs documentation</h3>
             <div class="pure-menu pure-menu-horizontal">
                 <ul class="pure-menu-list">
-                    {% set text = "info-circle" | fas | safe %}
+                    {% set text = "info-circle" | fas %}
                     {% set text = text ~ ' <span class="title">About</span>' %}
                     {{ macros::active_link(expected="index", href="/about", text=text) }}
 
-                    {% set text = "fonticons" | fab | safe %}
+                    {% set text = "fonticons" | fab%}
                     {% set text = text ~ ' <span class="title">Badges</span>' %}
                     {{ macros::active_link(expected="badges", href="/about/badges", text=text) }}
 
-                    {% set text = "cogs" | fas | safe %}
+                    {% set text = "cogs" | fas %}
                     {% set text = text ~ ' <span class="title">Builds</span>' %}
                     {{ macros::active_link(expected="builds", href="/about/builds", text=text) }}
 
-                    {% set text = "table" | fas | safe %}
+                    {% set text = "table" | fas %}
                     {% set text = text ~ ' <span class="title">Metadata</span>' %}
                     {{ macros::active_link(expected="metadata", href="/about/metadata", text=text) }}
 
-                    {% set text = "road" | fas | safe %}
+                    {% set text = "road" | fas %}
                     {% set text = text ~ ' <span class="title">Shorthand URLs</span>' %}
                     {{ macros::active_link(expected="redirections", href="/about/redirections", text=text) }}
                 </ul>
diff --git a/templates/base.html b/templates/base.html
@@ -1,5 +1,4 @@
 {%- import "macros.html" as macros -%}
-{%- import "icons.html" as fa -%}
 
 <!DOCTYPE html>
 <html lang="en">
diff --git a/templates/core/home.html b/templates/core/home.html
@@ -4,7 +4,7 @@
 
 {%- block body -%}
     <div class="container landing">
-        <h1 class="brand">{{ "cubes" | fas | safe }} Docs.rs</h1>
+        <h1 class="brand">{{ "cubes" | fas }} Docs.rs</h1>
 
         <form action="/releases/search" method="GET" class="landing-search-form">
             <div>
@@ -28,7 +28,7 @@ <h1 class="brand">{{ "cubes" | fas | safe }} Docs.rs</h1>
                     <strong>Recent Releases</strong>
                 </a>
                 <a href="/releases/feed" title="Atom feed">
-                    {{ "rss-square" | fas | safe }}
+                    {{ "rss-square" | fas }}
                 </a>
             </div>
 
@@ -54,7 +54,7 @@ <h1 class="brand">{{ "cubes" | fas | safe }} Docs.rs</h1>
                                 {%- if varsb.show_stars -%}
                                     <div class="pure-u-1 pure-u-sm-4-24 pure-u-md-3-24 date">
                                         {{ release.stars }}
-                                        {{ "star" | fas | safe }}
+                                        {{ "star" | fas }}
                                     </div>
                                 {%- else -%}
                                     <div class="pure-u-1 pure-u-sm-4-24 pure-u-md-3-24 date"
diff --git a/templates/crate/builds.html b/templates/crate/builds.html
@@ -43,9 +43,9 @@
                             <div class="pure-g">
                                 <div class="pure-u-1 pure-u-sm-1-24 build">
                                     {%- if build.build_status -%}
-                                        {{ "check" | fas | safe }}
+                                        {{ "check" | fas }}
                                     {%- else -%}
-                                        {{ "times" | fas | safe }}
+                                        {{ "times" | fas }}
                                     {%- endif -%}
                                 </div>
                                 <div class="pure-u-1 pure-u-sm-10-24">{{ build.rustc_version }}</div>
diff --git a/templates/crate/details.html b/templates/crate/details.html
@@ -32,7 +32,7 @@
                         {%- if details.homepage_url -%}
                             <li class="pure-menu-item">
                                 <a href="{{ details.homepage_url }}" class="pure-menu-link">
-                                    {{ "home" | fas | safe }} Homepage
+                                    {{ "home" | fas }} Homepage
                                 </a>
                             </li>
                         {%- endif -%}
@@ -41,7 +41,7 @@
                         {%- if details.documentation_url -%}
                             <li class="pure-menu-item">
                                 <a href="{{ details.documentation_url }}" title="Canonical documentation" class="pure-menu-link">
-                                    {{ "file-alt" | far | safe }} Documentation
+                                    {{ "file-alt" | far }} Documentation
                                 </a>
                             </li>
                         {%- endif -%}
@@ -53,14 +53,14 @@
                                     {# If the repo link is for github, show some github stats #}
                                     {# TODO: add support for hosts besides github (#35) #}
                                     {%- if details.github -%}
-                                        {{ "github" | fab| safe }}
-                                        {{ "star" | fas| safe }} {{ details.github_stars }}
-                                        {{ fa::s(icon="code-branch") }} {{ details.github_forks }}
-                                        {{ "exclamation-circle" | fas | safe }} {{ details.github_issues }}
+                                        {{ "github" | fab }}
+                                        {{ "star" | fas }} {{ details.github_stars }}
+                                        {{ "code-branch" | fas }} {{ details.github_forks }}
+                                        {{ "exclamation-circle" | fas }} {{ details.github_issues }}
 
                                     {# If the repo link is unknown, just show a normal link #}
                                     {%- else -%}
-                                        {{ fa::s(icon="code-branch") }} Repository
+                                        {{ "code-branch" | fas }} Repository
                                     {%- endif -%}
                                 </a>
                             </li>
@@ -70,7 +70,7 @@
                         <li class="pure-menu-item">
                             <a href="https://crates.io/crates/{{ details.name }}" class="pure-menu-link"
                                 title="See {{ details.name }} on crates.io">
-                                {{ "cube" | fas | safe }} Crates.io
+                                {{ "cube" | fas }} Crates.io
                             </a>
                         </li>
 
diff --git a/templates/crate/source.html b/templates/crate/source.html
@@ -19,7 +19,7 @@
                         {# If this isn't the root folder, show a 'back' button #}
                         {%- if show_parent_link -%}
                             <li class="pure-menu-item">
-                                <a href="../" class="pure-menu-link">{{ "folder-open" | far | safe }} ..</a>
+                                <a href="../" class="pure-menu-link">{{ "folder-open" | far }} ..</a>
                             </li>
                         {%- endif -%}
 
@@ -32,23 +32,23 @@
                                 <a href="./{{ file.name }}{% if file.mime == 'dir' %}/{% endif %}" class="pure-menu-link">
                                     {# Directories #}
                                     {%- if file.mime == "dir" -%}
-                                        {{ "folder-open" | far | safe }}
+                                        {{ "folder-open" | far }}
 
                                     {# Rust files #}
                                     {%- elif file.mime == "text/rust" -%}
-                                        {{ "rust" | fab | safe }}
+                                        {{ "rust" | fab }}
 
                                     {# Cargo.lock #}
                                     {%- elif file.mime == "text/plain" and file.name == "Cargo.lock" -%}
-                                        {{ "lock" | fas | safe }}
+                                        {{ "lock" | fas }}
 
                                     {# Markdown files #}
                                     {% elif file.mime == "text/markdown" %}
-                                        {{ "markdown" | fas | safe }}
+                                        {{ "markdown" | fab }}
 
                                     {# .gitignore #}
                                     {% elif file.mime == "text/plain" and file.name == ".gitignore" %}
-                                        {{ "git-alt" | fab | safe }}
+                                        {{ "git-alt" | fab }}
 
                                     {#
                                         More ideas
@@ -70,11 +70,11 @@
 
                                     {# Text files or files which mime starts with `text` #}
                                     {%- elif file.mime == "text/plain" or file.mime | split(pat="/") | first == "text" -%}
-                                        {{ "file-alt" | far | safe }}
+                                        {{ "file-alt" | far }}
 
                                     {# Binary files and any unrecognized types #}
                                     {% else -%}
-                                        {{ "file-archive" | far | safe }}
+                                        {{ "file-archive" | far }}
                                     {%- endif -%}
 
                                     {{ file.name }}
diff --git a/templates/header/global_alert.html b/templates/header/global_alert.html
@@ -5,7 +5,7 @@
 {%- if global_alert -%}
     <li class="pure-menu-item">
         <a href="{{ global_alert.url | safe }}" class="pure-menu-link {{ global_alert.css_class }}">
-            <i class="{{ global_alert.fa_icon | fas | safe }}"></i>
+            <i class="{{ global_alert.fa_icon | fas }}"></i>
             {{ global_alert.text }}
         </a>
     </li>
diff --git a/templates/header/package_navigation.html b/templates/header/package_navigation.html
@@ -62,7 +62,7 @@ <h1 id="crate-title">
                         <li class="pure-menu-item">
                             {# The docs tab redirects to the docs, so the tab will never be selected and seen #}
                             <a href="/{{ crate_path | safe }}/{{ metadata.target_name }}/" class="pure-menu-link">
-                                {{ "book" | fas | safe }}
+                                {{ "book" | fas }}
                                 <span class="title"> Documentation</span>
                             </a>
                         </li>
@@ -71,7 +71,7 @@ <h1 id="crate-title">
                     {# The crate information tab #}
                     <li class="pure-menu-item"><a href="/crate/{{ crate_path | safe }}"
                             class="pure-menu-link{% if active_tab == 'crate' %} pure-menu-active{% endif %}">
-                            {{ "cube" | fas | safe }}
+                            {{ "cube" | fas }}
                             <span class="title"> Crate</span>
                         </a>
                     </li>
@@ -80,7 +80,7 @@ <h1 id="crate-title">
                     <li class="pure-menu-item">
                         <a href="/crate/{{ crate_path | safe }}/source/"
                             class="pure-menu-link{% if active_tab == 'source' %} pure-menu-active{% endif %}">
-                            {{ "folder-open" | far | safe }}
+                            {{ "folder-open" | far }}
                             <span class="title"> Source</span>
                         </a>
                     </li>
@@ -89,7 +89,7 @@ <h1 id="crate-title">
                     <li class="pure-menu-item">
                         <a href="/crate/{{ crate_path | safe }}/builds"
                             class="pure-menu-link{% if active_tab == 'builds' %} pure-menu-active{% endif %}">
-                            {{ "cogs" | fas | safe }}
+                            {{ "cogs" | fas }}
                             <span class="title"> Builds</span>
                         </a>
                     </li>
diff --git a/templates/header/topbar.html b/templates/header/topbar.html
@@ -10,7 +10,7 @@
                 {# The search bar #}
                 <div id="search-input-nav">
                     <label for="nav-search">
-                        {{ "search" | fas | safe }}
+                        {{ "search" | fas }}
                     </label>
 
                     {# If there is a search query, put it in the search bar #}
@@ -20,7 +20,7 @@
 
                 {# The top-left logo and name #}
                 <a href="/" class="pure-menu-heading pure-menu-link" aria-label="Docs.rs">
-                    {{ "book" | fas | safe }} Docs.rs
+                    {{ "cubes" | fas }} Docs.rs
                 </a>
 
                 <ul class="pure-menu-list">
diff --git a/templates/icons.html b/templates/icons.html
diff --git a/templates/macros.html b/templates/macros.html
@@ -126,26 +126,26 @@
             {# If the release isn't a library, then display that warning #}
             {% if not release.is_library -%}
                 <a href="{{ release_url | safe }}" class="pure-menu-link warn" title="{{ release_name }} is not a library">
-                    {{ fa::s(icon="exclamation-triangle") }} {{ release.version }}
+                    {{ "exclamation-triangle" | fas }} {{ release.version }}
                 </a>
 
             {# If the release has been yanked and failed to build, display a warning #}
             {%- elif release.yanked and release.build_status -%}
                 <a href="{{ release_url | safe }}" class="pure-menu-link warn" title="{{ release_name }} is yanked">
-                    {{ fa::s(icon="exclamation-triangle") }} {{ release.version }}
+                    {{ "exclamation-triangle" | fas }} {{ release.version }}
                 </a>
 
             {# If the release has been yanked and failed to build, display a warning #}
             {%- elif release.yanked and not release.build_status -%}
                 <a href="{{ release_url | safe }}" class="pure-menu-link warn"
                     title="{{ release_name }} is yanked and docs.rs failed to build it">
-                    {{ fa::s(icon="exclamation-triangle") }} {{ release.version }}
+                    {{ "exclamation-triangle" | fas }} {{ release.version }}
                 </a>
 
             {# If the release failed to build, display a warning #}
             {%- elif not release.build_status -%}
                 <a href="{{ release_url | safe }}" class="pure-menu-link warn" title="docs.rs failed to build {{ release_name }}">
-                    {{ fa::s(icon="exclamation-triangle") }} {{ release.version }}
+                    {{ "exclamation-triangle" | fas }} {{ release.version }}
                 </a>
 
             {# Otherwise just display the version #}
diff --git a/templates/releases/header.html b/templates/releases/header.html
diff --git a/templates/releases/releases.html b/templates/releases/releases.html
diff --git a/templates/rustdoc/body.html b/templates/rustdoc/body.html
diff --git a/templates/style/base.scss b/templates/style/base.scss

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{%- import "macros.html" as macros -%}`
`2`		`-{%- import "icons.html" as fa -%}`
`3`	`2`
`4`	`3`	`<!DOCTYPE html>`
`5`	`4`	`<html lang="en">`