{default}').format(default=DEFAULT_MIME_TYPE),
+ )
+ 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 DEFAULT_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 ''
+ if self.file_name:
+ filename = self.file_name
+ elif queryset:
+ filename = filename_from_model(queryset.model)
+ elif context:
+ filename = filename_from_object(context)
+ else:
+ filename = "output"
+ response['Content-Disposition'] = f'attachment; filename="{filename}{extension}"'
+
+ return response
diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py
index 3cae54f29..76fad1082 100644
--- a/netbox/extras/models/models.py
+++ b/netbox/extras/models/models.py
@@ -6,7 +6,6 @@ from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelatio
from django.contrib.postgres.fields import ArrayField
from django.core.validators import ValidationError
from django.db import models
-from django.http import HttpResponse
from django.urls import reverse
from django.utils import timezone
from django.utils.translation import gettext_lazy as _
@@ -16,12 +15,13 @@ from core.models import ObjectType
from extras.choices import *
from extras.conditions import ConditionSet
from extras.constants import *
-from extras.utils import filename_from_model, image_upload
+from extras.utils import image_upload
+from extras.models.mixins import RenderTemplateMixin
from netbox.config import get_config
from netbox.events import get_event_type_choices
from netbox.models import ChangeLoggedModel
from netbox.models.features import (
- CloningMixin, CustomFieldsMixin, CustomLinksMixin, ExportTemplatesMixin, SyncedDataMixin, TagsMixin,
+ CloningMixin, CustomFieldsMixin, CustomLinksMixin, ExportTemplatesMixin, SyncedDataMixin, TagsMixin
)
from utilities.html import clean_html
from utilities.jinja2 import render_jinja2
@@ -382,7 +382,7 @@ class CustomLink(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
}
-class ExportTemplate(SyncedDataMixin, CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
+class ExportTemplate(SyncedDataMixin, CloningMixin, ExportTemplatesMixin, ChangeLoggedModel, RenderTemplateMixin):
object_types = models.ManyToManyField(
to='core.ObjectType',
related_name='export_templates',
@@ -397,34 +397,6 @@ class ExportTemplate(SyncedDataMixin, CloningMixin, ExportTemplatesMixin, Change
max_length=200,
blank=True
)
- template_code = models.TextField(
- help_text=_(
- "Jinja2 template code. The list of objects being exported is passed as a context variable named "
- "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 +432,16 @@ 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 = {
- 'queryset': queryset
+ def get_context(self, context=None, queryset=None):
+ _context = {
+ 'queryset': queryset,
}
- output = render_jinja2(self.template_code, context)
- # Replace CRLF-style line terminators
- output = output.replace('\r\n', '\n')
+ # Apply the provided context data, if any
+ if context is not None:
+ _context.update(context)
- 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 _context
class SavedFilter(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py
index 7a6e79cab..60b207058 100644
--- a/netbox/extras/tables/tables.py
+++ b/netbox/extras/tables/tables.py
@@ -183,6 +183,15 @@ class ExportTemplateTable(NetBoxTable):
object_types = columns.ContentTypesColumn(
verbose_name=_('Object Types'),
)
+ mime_type = tables.Column(
+ verbose_name=_('MIME Type')
+ )
+ file_name = tables.Column(
+ verbose_name=_('File Name'),
+ )
+ file_extension = tables.Column(
+ verbose_name=_('File Extension'),
+ )
as_attachment = columns.BooleanColumn(
verbose_name=_('As Attachment'),
false_mark=None
@@ -527,6 +536,19 @@ class ConfigTemplateTable(NetBoxTable):
orderable=False,
verbose_name=_('Synced')
)
+ mime_type = tables.Column(
+ verbose_name=_('MIME Type')
+ )
+ file_name = tables.Column(
+ verbose_name=_('File Name'),
+ )
+ file_extension = tables.Column(
+ verbose_name=_('File Extension'),
+ )
+ as_attachment = columns.BooleanColumn(
+ verbose_name=_('As Attachment'),
+ false_mark=None
+ )
tags = columns.TagColumn(
url_name='extras:configtemplate_list'
)
@@ -554,8 +576,9 @@ class ConfigTemplateTable(NetBoxTable):
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',
+ 'pk', 'id', 'name', 'description', 'data_source', 'data_file', 'data_synced', 'as_attachment',
+ 'mime_type', 'file_name', 'file_extension', 'role_count', 'platform_count', 'device_count',
+ 'vm_count', 'created', 'last_updated', 'tags',
)
default_columns = (
'pk', 'name', 'description', 'is_synced', 'device_count', 'vm_count',
diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py
index 7a4d63549..6e3fb37fc 100644
--- a/netbox/extras/tests/test_api.py
+++ b/netbox/extras/tests/test_api.py
@@ -755,6 +755,10 @@ class ConfigTemplateTest(APIViewTestCases.APIViewTestCase):
{
'name': 'Config Template 4',
'template_code': 'Foo: {{ foo }}',
+ 'mime_type': 'text/plain',
+ 'file_name': 'output4',
+ 'file_extension': 'txt',
+ 'as_attachment': True,
},
{
'name': 'Config Template 5',
@@ -778,7 +782,7 @@ class ConfigTemplateTest(APIViewTestCases.APIViewTestCase):
),
ConfigTemplate(
name='Config Template 2',
- template_code='Bar: {{ bar }}'
+ template_code='Bar: {{ bar }}',
),
ConfigTemplate(
name='Config Template 3',
diff --git a/netbox/extras/tests/test_filtersets.py b/netbox/extras/tests/test_filtersets.py
index 247653472..987dfe0ff 100644
--- a/netbox/extras/tests/test_filtersets.py
+++ b/netbox/extras/tests/test_filtersets.py
@@ -616,19 +616,39 @@ 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):
object_types = ObjectType.objects.filter(model__in=['site', 'rack', 'device'])
export_templates = (
- ExportTemplate(name='Export Template 1', template_code='TESTING', description='foobar1'),
ExportTemplate(
- name='Export Template 2', template_code='TESTING', description='foobar2',
- file_name='export_template_2', file_extension='nagios',
+ name='Export Template 1',
+ template_code='TESTING',
+ description='foobar1',
+ mime_type='text/foo',
+ file_name='foo',
+ file_extension='foo',
+ as_attachment=True,
+ ),
+ ExportTemplate(
+ name='Export Template 2',
+ template_code='TESTING',
+ description='foobar2',
+ mime_type='text/bar',
+ file_name='bar',
+ file_extension='bar',
+ as_attachment=True,
+ ),
+ ExportTemplate(
+ name='Export Template 3',
+ template_code='TESTING',
+ mime_type='text/baz',
+ file_name='baz',
+ file_extension='baz',
+ as_attachment=False,
),
- ExportTemplate(name='Export Template 3', template_code='TESTING', file_name='export_filename'),
)
ExportTemplate.objects.bulk_create(export_templates)
for i, et in enumerate(export_templates):
@@ -638,9 +658,6 @@ class ExportTemplateTestCase(TestCase, ChangeLoggedFilterSetTests):
params = {'q': 'foobar1'}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
- params = {'q': 'export_filename'}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
-
def test_name(self):
params = {'name': ['Export Template 1', 'Export Template 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -655,19 +672,21 @@ class ExportTemplateTestCase(TestCase, ChangeLoggedFilterSetTests):
params = {'description': ['foobar1', 'foobar2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_mime_type(self):
+ params = {'mime_type': ['text/foo', 'text/bar']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
def test_file_name(self):
- params = {'file_name': ['export_filename']}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+ params = {'file_name': ['foo', 'bar']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
def test_file_extension(self):
- params = {'file_extension': ['nagios']}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+ params = {'file_extension': ['foo', 'bar']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
- params = {'file_name': ['export_template_2'], 'file_extension': ['nagios']}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
-
- params = {'file_name': 'export_filename', 'file_extension': ['nagios']}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 0)
+ def test_as_attachment(self):
+ params = {'as_attachment': True}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
class ImageAttachmentTestCase(TestCase, ChangeLoggedFilterSetTests):
@@ -1088,9 +1107,32 @@ class ConfigTemplateTestCase(TestCase, ChangeLoggedFilterSetTests):
@classmethod
def setUpTestData(cls):
config_templates = (
- ConfigTemplate(name='Config Template 1', template_code='TESTING', description='foobar1'),
- ConfigTemplate(name='Config Template 2', template_code='TESTING', description='foobar2'),
- ConfigTemplate(name='Config Template 3', template_code='TESTING'),
+ ConfigTemplate(
+ name='Config Template 1',
+ template_code='TESTING',
+ description='foobar1',
+ mime_type='text/foo',
+ file_name='foo',
+ file_extension='foo',
+ as_attachment=True,
+ ),
+ ConfigTemplate(
+ name='Config Template 2',
+ template_code='TESTING',
+ description='foobar2',
+ mime_type='text/bar',
+ file_name='bar',
+ file_extension='bar',
+ as_attachment=True,
+ ),
+ ConfigTemplate(
+ name='Config Template 3',
+ template_code='TESTING',
+ mime_type='text/baz',
+ file_name='baz',
+ file_extension='baz',
+ as_attachment=False,
+ ),
)
ConfigTemplate.objects.bulk_create(config_templates)
@@ -1106,6 +1148,22 @@ class ConfigTemplateTestCase(TestCase, ChangeLoggedFilterSetTests):
params = {'description': ['foobar1', 'foobar2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_mime_type(self):
+ params = {'mime_type': ['text/foo', 'text/bar']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_file_name(self):
+ params = {'file_name': ['foo', 'bar']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_file_extension(self):
+ params = {'file_extension': ['foo', 'bar']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_as_attachment(self):
+ params = {'as_attachment': True}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
class TagTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = Tag.objects.all()
diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py
index 0688cd2c2..6378b29b8 100644
--- a/netbox/extras/tests/test_views.py
+++ b/netbox/extras/tests/test_views.py
@@ -301,10 +301,13 @@ class ExportTemplateTestCase(ViewTestCases.PrimaryObjectViewTestCase):
def setUpTestData(cls):
site_type = ObjectType.objects.get_for_model(Site)
TEMPLATE_CODE = """{% for object in queryset %}{{ object }}{% endfor %}"""
+ ENVIRONMENT_PARAMS = """{"trim_blocks": true}"""
export_templates = (
ExportTemplate(name='Export Template 1', template_code=TEMPLATE_CODE),
- ExportTemplate(name='Export Template 2', template_code=TEMPLATE_CODE),
+ ExportTemplate(
+ name='Export Template 2', template_code=TEMPLATE_CODE, environment_params={"trim_blocks": True}
+ ),
ExportTemplate(name='Export Template 3', template_code=TEMPLATE_CODE, file_name='export_template_3')
)
ExportTemplate.objects.bulk_create(export_templates)
@@ -315,6 +318,7 @@ class ExportTemplateTestCase(ViewTestCases.PrimaryObjectViewTestCase):
'name': 'Export Template X',
'object_types': [site_type.pk],
'template_code': TEMPLATE_CODE,
+ 'environment_params': ENVIRONMENT_PARAMS,
'file_name': 'template_x',
}
@@ -537,11 +541,23 @@ class ConfigTemplateTestCase(
@classmethod
def setUpTestData(cls):
TEMPLATE_CODE = """Foo: {{ foo }}"""
+ ENVIRONMENT_PARAMS = """{"trim_blocks": true}"""
config_templates = (
- ConfigTemplate(name='Config Template 1', template_code=TEMPLATE_CODE),
- ConfigTemplate(name='Config Template 2', template_code=TEMPLATE_CODE),
- ConfigTemplate(name='Config Template 3', template_code=TEMPLATE_CODE),
+ ConfigTemplate(
+ name='Config Template 1',
+ template_code=TEMPLATE_CODE)
+ ,
+ ConfigTemplate(
+ name='Config Template 2',
+ template_code=TEMPLATE_CODE,
+ environment_params={"trim_blocks": True},
+ ),
+ ConfigTemplate(
+ name='Config Template 3',
+ template_code=TEMPLATE_CODE,
+ file_name='config_template_3',
+ ),
)
ConfigTemplate.objects.bulk_create(config_templates)
@@ -549,6 +565,8 @@ class ConfigTemplateTestCase(
'name': 'Config Template X',
'description': 'Config template',
'template_code': TEMPLATE_CODE,
+ 'environment_params': ENVIRONMENT_PARAMS,
+ 'file_name': 'config_x',
}
cls.csv_update_data = (
@@ -560,6 +578,10 @@ class ConfigTemplateTestCase(
cls.bulk_edit_data = {
'description': 'New description',
+ 'mime_type': 'text/html',
+ 'file_name': 'output',
+ 'file_extension': 'html',
+ 'as_attachment': True,
}
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/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..eeb962cfb 100644
--- a/netbox/templates/extras/configtemplate.html
+++ b/netbox/templates/extras/configtemplate.html
@@ -4,8 +4,8 @@
{% load i18n %}
{% block content %}
- | {% trans "Description" %} | {{ object.description|placeholder }} | +
|---|---|
| {% trans "MIME Type" %} | +{{ object.mime_type|placeholder }} | +
| {% trans "File Name" %} | +{{ object.file_name|placeholder }} | +
| {% trans "File Extension" %} | +{{ object.file_extension|placeholder }} | +
| {% trans "Attachment" %} | +{% checkmark object.as_attachment %} | +
| {% trans "Data Source" %} |
@@ -51,7 +67,7 @@
{% include 'inc/panels/tags.html' %}
{% plugin_left_page object %}
-
+ {% trans "Environment Parameters" %}
diff --git a/netbox/templates/extras/exporttemplate.html b/netbox/templates/extras/exporttemplate.html
index f0e370c03..fd1e56d11 100644
--- a/netbox/templates/extras/exporttemplate.html
+++ b/netbox/templates/extras/exporttemplate.html
@@ -6,8 +6,8 @@
{% block title %}{{ object.name }}{% endblock %}
{% block content %}
-
-
+
+ {% trans "Export Template" %}{% trans "Assigned Models" %}
-
{% plugin_right_page object %}
@@ -91,6 +90,13 @@
{% trans "Template" %}+{% trans "Environment Parameters" %}
- {% include 'inc/sync_warning.html' %}
-
{{ object.template_code }}
+ {{ object.environment_params }}
+
+
{% plugin_full_width_page object %}
{% trans "Template" %}+
+ {% include 'inc/sync_warning.html' %}
+
+ {{ object.template_code }}
+ |