queryset."
- )
- )
- mime_type = models.CharField(
- max_length=50,
- blank=True,
- verbose_name=_('MIME type'),
- help_text=_('Defaults to text/plain; charset=utf-8')
- )
- file_name = models.CharField(
- max_length=200,
- blank=True,
- help_text=_('Filename to give to the rendered export file')
- )
- file_extension = models.CharField(
- verbose_name=_('file extension'),
- max_length=15,
- blank=True,
- help_text=_('Extension to append to the rendered filename')
- )
- as_attachment = models.BooleanField(
- verbose_name=_('as attachment'),
- default=True,
- help_text=_("Download file as attachment")
- )
clone_fields = (
'object_types', 'template_code', 'mime_type', 'file_name', 'file_extension', 'as_attachment',
@@ -460,37 +431,11 @@ class ExportTemplate(SyncedDataMixin, CloningMixin, ExportTemplatesMixin, Change
self.template_code = self.data_file.data_as_string
sync_data.alters_data = True
- def render(self, queryset):
- """
- Render the contents of the template.
- """
- context = {
+ def get_context(self, context=None, queryset=None):
+ export_context = {
'queryset': queryset
}
- output = render_jinja2(self.template_code, context)
-
- # Replace CRLF-style line terminators
- output = output.replace('\r\n', '\n')
-
- return output
-
- def render_to_response(self, queryset):
- """
- Render the template to an HTTP response, delivered as a named file attachment
- """
- output = self.render(queryset)
- mime_type = 'text/plain; charset=utf-8' if not self.mime_type else self.mime_type
-
- # Build the response
- response = HttpResponse(output, content_type=mime_type)
-
- if self.as_attachment:
- extension = f'.{self.file_extension}' if self.file_extension else ''
- filename = self.file_name or filename_from_model(queryset.model)
- full_filename = f'{filename}{extension}'
- response['Content-Disposition'] = f'attachment; filename="{full_filename}"'
-
- return response
+ return export_context
class SavedFilter(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py
index 7a6e79cab..a28ea2712 100644
--- a/netbox/extras/tables/tables.py
+++ b/netbox/extras/tables/tables.py
@@ -550,12 +550,17 @@ class ConfigTemplateTable(NetBoxTable):
url_params={'config_template_id': 'pk'},
verbose_name=_('Virtual Machines')
)
+ as_attachment = columns.BooleanColumn(
+ verbose_name=_('As Attachment'),
+ false_mark=None
+ )
class Meta(NetBoxTable.Meta):
model = ConfigTemplate
fields = (
'pk', 'id', 'name', 'description', 'data_source', 'data_file', 'data_synced', 'role_count',
- 'platform_count', 'device_count', 'vm_count', 'created', 'last_updated', 'tags',
+ 'platform_count', 'device_count', 'vm_count', 'created', 'last_updated', 'tags', 'as_attachment',
+ 'mime_type', 'file_name', 'file_extension',
)
default_columns = (
'pk', 'name', 'description', 'is_synced', 'device_count', 'vm_count',
diff --git a/netbox/extras/tests/test_filtersets.py b/netbox/extras/tests/test_filtersets.py
index 247653472..eb3dc93de 100644
--- a/netbox/extras/tests/test_filtersets.py
+++ b/netbox/extras/tests/test_filtersets.py
@@ -616,7 +616,7 @@ class BookmarkTestCase(TestCase, BaseFilterSetTests):
class ExportTemplateTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = ExportTemplate.objects.all()
filterset = ExportTemplateFilterSet
- ignore_fields = ('template_code', 'data_path')
+ ignore_fields = ('template_code', 'environment_params', 'data_path')
@classmethod
def setUpTestData(cls):
diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py
index 411d80f78..155597c30 100644
--- a/netbox/extras/utils.py
+++ b/netbox/extras/utils.py
@@ -22,6 +22,17 @@ def filename_from_model(model: models.Model) -> str:
return f'netbox_{base}'
+def filename_from_object(context: dict) -> str:
+ """Standardises how we generate filenames from model class for exports"""
+ if 'device' in context:
+ base = f"{context['device'].name or 'config'}"
+ elif 'virtualmachine' in context:
+ base = f"{context['virtualmachine'].name or 'config'}"
+ else:
+ base = 'config'
+ return base
+
+
def is_taggable(obj):
"""
Return True if the instance can have Tags assigned to it; False otherwise.
diff --git a/netbox/netbox/api/viewsets/mixins.py b/netbox/netbox/api/viewsets/mixins.py
index e07e2c78b..e21be2348 100644
--- a/netbox/netbox/api/viewsets/mixins.py
+++ b/netbox/netbox/api/viewsets/mixins.py
@@ -45,7 +45,7 @@ class ExportTemplatesMixin:
if et is None:
raise Http404
queryset = self.filter_queryset(self.get_queryset())
- return et.render_to_response(queryset)
+ return et.render_to_response(queryset=queryset)
return super().list(request, *args, **kwargs)
diff --git a/netbox/netbox/models/features.py b/netbox/netbox/models/features.py
index d14fdb17f..9173ae99e 100644
--- a/netbox/netbox/models/features.py
+++ b/netbox/netbox/models/features.py
@@ -6,6 +6,7 @@ from django.contrib.contenttypes.fields import GenericRelation
from django.core.validators import ValidationError
from django.db import models
from django.db.models import Q
+from django.http import HttpResponse
from django.utils import timezone
from django.utils.translation import gettext_lazy as _
from taggit.managers import TaggableManager
@@ -14,10 +15,11 @@ from core.choices import JobStatusChoices, ObjectChangeActionChoices
from core.models import ObjectType
from extras.choices import *
from extras.constants import CUSTOMFIELD_EMPTY_VALUES
-from extras.utils import is_taggable
+from extras.utils import is_taggable, filename_from_model, filename_from_object
from netbox.config import get_config
from netbox.registry import registry
from netbox.signals import post_clean
+from utilities.jinja2 import render_jinja2
from utilities.json import CustomFieldJSONEncoder
from utilities.serialization import serialize_object
from utilities.views import register_model_view
@@ -37,6 +39,7 @@ __all__ = (
'JournalingMixin',
'NotificationsMixin',
'SyncedDataMixin',
+ 'RenderMixin',
'TagsMixin',
'register_models',
)
@@ -337,6 +340,87 @@ class ExportTemplatesMixin(models.Model):
abstract = True
+class RenderMixin(models.Model):
+ """
+ Enables support for rendering templates.
+ """
+ template_code = models.TextField(
+ verbose_name=_('template code'),
+ help_text=_('Jinja2 template code.')
+ )
+ environment_params = models.JSONField(
+ verbose_name=_('environment parameters'),
+ blank=True,
+ null=True,
+ default=dict,
+ help_text=_(
+ 'Any additional parameters'
+ ' to pass when constructing the Jinja2 environment.'
+ )
+ )
+ mime_type = models.CharField(
+ max_length=50,
+ blank=True,
+ verbose_name=_('MIME type'),
+ help_text=_('Defaults to text/plain; charset=utf-8')
+ )
+ file_name = models.CharField(
+ max_length=200,
+ blank=True,
+ help_text=_('Filename to give to the rendered export file')
+ )
+ file_extension = models.CharField(
+ verbose_name=_('file extension'),
+ max_length=15,
+ blank=True,
+ help_text=_('Extension to append to the rendered filename')
+ )
+ as_attachment = models.BooleanField(
+ verbose_name=_('as attachment'),
+ default=True,
+ help_text=_("Download file as attachment")
+ )
+
+ class Meta:
+ abstract = True
+
+ def get_context(self, context=None, queryset=None):
+ raise NotImplementedError(_("{class_name} must implement a get_context() method.").format(
+ class_name=self.__class__
+ ))
+
+ def render(self, context=None, queryset=None):
+ """
+ Render the template with the provided context. The context is passed to the Jinja2 environment as a dictionary.
+ """
+ context = self.get_context(context=context, queryset=queryset)
+ env_params = self.environment_params or {}
+ output = render_jinja2(self.template_code, context, env_params)
+
+ # Replace CRLF-style line terminators
+ output = output.replace('\r\n', '\n')
+
+ return output
+
+ def render_to_response(self, context=None, queryset=None):
+ output = self.render(context=context, queryset=queryset)
+ mime_type = self.mime_type or 'text/plain; charset=utf-8'
+
+ # Build the response
+ response = HttpResponse(output, content_type=mime_type)
+
+ if self.as_attachment:
+ extension = f'.{self.file_extension}' if self.file_extension else ''
+ if queryset:
+ filename = self.file_name or filename_from_model(queryset.model)
+ elif context:
+ filename = self.file_name or filename_from_object(context)
+ full_filename = f'{filename}{extension}'
+ response['Content-Disposition'] = f'attachment; filename="{full_filename}"'
+
+ return response
+
+
class ImageAttachmentsMixin(models.Model):
"""
Enables the assignments of ImageAttachments.
diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py
index 88857ad54..447e2a6c5 100644
--- a/netbox/netbox/views/generic/bulk_views.py
+++ b/netbox/netbox/views/generic/bulk_views.py
@@ -107,7 +107,7 @@ class ObjectListView(BaseMultiObjectView, ActionsMixin, TableMixin):
request: The current request
"""
try:
- return template.render_to_response(self.queryset)
+ return template.render_to_response(queryset=self.queryset)
except Exception as e:
messages.error(
request,
diff --git a/netbox/templates/extras/configtemplate.html b/netbox/templates/extras/configtemplate.html
index 5218a3b8f..55676413e 100644
--- a/netbox/templates/extras/configtemplate.html
+++ b/netbox/templates/extras/configtemplate.html
@@ -17,6 +17,22 @@
{{ object.template_code }}
+ {{ object.environment_params }}
+