Move extras.jinja2.ConfigTemplateLoader to utilities.jinja2.DataFileLoader

netbox/extras/jinja2.py

@@ -1,37 +0,0 @@
-from django.apps import apps
-from jinja2 import BaseLoader, TemplateNotFound
-from jinja2.meta import find_referenced_templates
-
-__all__ = (
-    'ConfigTemplateLoader',
-)
-
-
-class ConfigTemplateLoader(BaseLoader):
-    """
-    Custom Jinja2 loader to facilitate populating template content from DataFiles.
-    """
-    def __init__(self, data_source):
-        self.data_source = data_source
-        self._template_cache = {}
-
-    def get_source(self, environment, template):
-        DataFile = apps.get_model('core', 'DataFile')
-
-        # Retrieve template content from cache
-        try:
-            template_source = self._template_cache[template]
-        except KeyError:
-            raise TemplateNotFound(template)
-
-        # Find and pre-fetch referenced templates
-        if referenced_templates := find_referenced_templates(environment.parse(template_source)):
-            self.cache_templates({
-                df.path: df.data_as_string for df in
-                DataFile.objects.filter(source=self.data_source, path__in=referenced_templates)
-            })
-
-        return template_source, template, lambda: True
-
-    def cache_templates(self, templates):
-        self._template_cache.update(templates)

netbox/extras/models/configs.py

@@ -7,12 +7,12 @@ from django.utils.translation import gettext_lazy as _
 from jinja2.loaders import BaseLoader
 from jinja2.sandbox import SandboxedEnvironment
 
-from extras.jinja2 import ConfigTemplateLoader
 from extras.querysets import ConfigContextQuerySet
 from netbox.config import get_config
 from netbox.registry import registry
 from netbox.models import ChangeLoggedModel
 from netbox.models.features import CloningMixin, CustomLinksMixin, ExportTemplatesMixin, SyncedDataMixin, TagsMixin
+from utilities.jinja2 import DataFileLoader
 from utilities.utils import deepmerge
 
 __all__ = (
@@ -290,7 +290,7 @@ class ConfigTemplate(SyncedDataMixin, CustomLinksMixin, ExportTemplatesMixin, Ta
         """
         # Initialize the template loader & cache the base template code (if applicable)
         if self.data_file:
-            loader = ConfigTemplateLoader(data_source=self.data_source)
+            loader = DataFileLoader(data_source=self.data_source)
             loader.cache_templates({
                 self.data_file.path: self.template_code
             })