refactor: turn jinja filters without args into functions

jstucke · jstucke · commit 04f7a603de1c · 2026-01-09T14:31:00.000+01:00
diff --git a/src/test/unit/web_interface/test_app_jinja_filter.py b/src/test/unit/web_interface/test_app_jinja_filter.py
@@ -6,7 +6,7 @@
 
 @pytest.fixture
 def filter_class(web_frontend):
-    return FilterClass(web_frontend.app, '', web_frontend.db)
+    return FilterClass(web_frontend.app, web_frontend.db)
 
 
 class TestAppShowAnalysis:
diff --git a/src/test/unit/web_interface/test_app_jinja_functions.py b/src/test/unit/web_interface/test_app_jinja_functions.py
@@ -0,0 +1,25 @@
+from typing import Any
+
+import pytest
+from flask import render_template_string
+
+from version import __VERSION__
+
+
+def test_auth_is_disabled(web_frontend):
+    _assert_is_rendered(web_frontend, 'auth_is_enabled', False)
+
+
+@pytest.mark.frontend_config_overwrite({'authentication': {'enabled': True}})
+def test_auth_is_enabled(web_frontend):
+    _assert_is_rendered(web_frontend, 'auth_is_enabled', True)
+
+
+def test_get_fact_version(web_frontend):
+    _assert_is_rendered(web_frontend, 'get_fact_version', __VERSION__)
+
+
+def _assert_is_rendered(web_frontend, function: str, expected_value: Any):
+    with web_frontend.app.test_request_context():
+        template = render_template_string(f'<html><body><div>{{{{ {function}() }}}}</div></body></html>')
+        assert f'<div>{expected_value}</div>' in template
diff --git a/src/web_interface/components/jinja_filter.py b/src/web_interface/components/jinja_filter.py
@@ -27,16 +27,12 @@ class FilterClass:
     This is WEB front end main class
     """
 
-    def __init__(self, app, program_version, db: FrontendDatabase, **_):
-        self._program_version = program_version
+    def __init__(self, app, db: FrontendDatabase, **_):
         self._app = app
         self.db = db
 
         self._setup_filters()
 
-    def _filter_print_program_version(self, *_):
-        return f'{self._program_version}'
-
     def _filter_replace_uid_with_file_name(self, input_data):
         tmp = input_data.__str__()
         uid_list = flt.get_all_uids_in_string(tmp)
@@ -117,9 +113,6 @@ def _virtual_path_element_to_span(hid_element: str, uid: str, root_uid: str, cur
             '</span>'
         )
 
-    def check_auth(self, _):
-        return config.frontend.authentication.enabled
-
     def data_to_chart_limited(self, data, limit: int | None = None, color_list=None):
         limit = self._get_chart_element_count() if limit is None else limit
         try:
@@ -150,7 +143,6 @@ def _setup_filters(self):
             {
                 'all_items_equal': lambda data: len({str(value) for value in data.values()}) == 1,
                 'as_ascii_table': flt.as_ascii_table,
-                'auth_enabled': self.check_auth,
                 'base64_encode': flt.encode_base64_filter,
                 'bytes_to_str': flt.bytes_to_str_filter,
                 'data_to_chart': self.data_to_chart,
@@ -189,7 +181,6 @@ def _setup_filters(self):
                 'nice_virtual_path_list': self._nice_virtual_path_list,
                 'number_format': flt.byte_number_filter,
                 'octal_to_readable': flt.octal_to_readable,
-                'print_program_version': self._filter_print_program_version,
                 'regex_meta': flt.comment_out_regex_meta_chars,
                 'remaining_time': elapsed_time,
                 'render_analysis_tags': flt.render_analysis_tags,
diff --git a/src/web_interface/frontend_main.py b/src/web_interface/frontend_main.py
@@ -1,10 +1,12 @@
 from __future__ import annotations
 
 import logging
+from inspect import getmembers, isfunction
 
 from intercom.front_end_binding import InterComFrontEndBinding
 from storage.redis_status_interface import RedisStatusInterface
 from version import __VERSION__
+from web_interface import jinja_functions
 from web_interface.app import create_app
 from web_interface.components.ajax_routes import AjaxRoutes
 from web_interface.components.analysis_routes import AnalysisRoutes
@@ -29,6 +31,7 @@ def __init__(self, db: FrontendDatabase | None = None, intercom=None, status_int
         self.status_interface = RedisStatusInterface() if status_interface is None else status_interface
 
         self._setup_app()
+        self._register_jinja_functions()
         logging.info('Web front end online')
 
     def _setup_app(self):
@@ -47,4 +50,13 @@ def _setup_app(self):
 
         rest_base = RestBase(**base_args)
         PluginRoutes(**base_args, api=rest_base.api)
-        FilterClass(self.app, self.program_version, self.db)
+        FilterClass(self.app, self.db)
+
+    def _register_jinja_functions(self):
+        # add functions from the module to the globals in jinja so that the functions can be called from templates
+        for function_name, function in getmembers(jinja_functions, isfunction):
+            if (
+                (not function_name.startswith('_'))  # we assume all function beginning with "_" are helper functions
+                and (function.__module__ == jinja_functions.__name__)  # only functions from the module, no imports
+            ):
+                self.app.jinja_env.globals.update({function_name: function})
diff --git a/src/web_interface/jinja_functions.py b/src/web_interface/jinja_functions.py
@@ -0,0 +1,10 @@
+import config
+from version import __VERSION__
+
+
+def auth_is_enabled() -> bool:
+    return config.frontend.authentication.enabled
+
+
+def get_fact_version():
+    return __VERSION__
diff --git a/src/web_interface/templates/base.html b/src/web_interface/templates/base.html
@@ -113,7 +113,7 @@
                 {{ navbar_dropdown_item("/admin/missing_analyses", "search", "Find Missing Analyses") }}
                 {{ navbar_dropdown_item("/admin/logs", "exclamation-circle", "Logs") }}
             {% endcall %}
-            {% if ("" | auth_enabled) %}
+            {% if auth_is_enabled() %}
                 {% if current_user.is_authenticated %}
                     {% call navbar_dropdown_menu(current_user.email | truncate(12), "user") %}
                         {{ navbar_dropdown_item("/user_profile", "user-cog", "Profile") }}
@@ -177,7 +177,7 @@
 
     <div class="row justify-content-center mb-2">
         <div class="col-md-4 text-center">
-            powered by <a href="https://fkie-cad.github.io/FACT_core/">FACT {{ "" | print_program_version }}</a><br/>
+            powered by <a href="https://fkie-cad.github.io/FACT_core/">FACT {{ get_fact_version() }}</a><br/>
             &copy; <a href="http://www.fkie.fraunhofer.de">Fraunhofer FKIE</a> 2015-2026
         </div>
     </div>
