' # Line break - help_text += f'Current value: {value}' - if is_static: - help_text += ' (defined statically)' - elif value == param.default: - help_text += ' (default)' - self.fields[param.name].help_text = help_text - if is_static: - self.fields[param.name].disabled = True - - def save(self, commit=True): - instance = super().save(commit=False) - - # Populate JSON data on the instance - instance.data = self.render_json() - - if commit: - instance.save() - - return instance - - def render_json(self): - json = {} - - # Iterate through each field and populate non-empty values - for field_name in self.declared_fields: - if field_name in self.cleaned_data and self.cleaned_data[field_name] not in EMPTY_VALUES: - json[field_name] = self.cleaned_data[field_name] - - return json diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py index 53de81ba2..bcf2e7863 100644 --- a/netbox/extras/forms/filtersets.py +++ b/netbox/extras/forms/filtersets.py @@ -18,6 +18,7 @@ from .mixins import SavedFiltersMixin __all__ = ( 'ConfigContextFilterForm', + 'ConfigRevisionFilterForm', 'ConfigTemplateFilterForm', 'CustomFieldFilterForm', 'CustomLinkFilterForm', @@ -444,3 +445,9 @@ class ObjectChangeFilterForm(SavedFiltersMixin, FilterForm): api_url='/api/extras/content-types/', ) ) + + +class ConfigRevisionFilterForm(SavedFiltersMixin, FilterForm): + fieldsets = ( + (None, ('q', 'filter_id')), + ) diff --git a/netbox/extras/forms/model_forms.py b/netbox/extras/forms/model_forms.py index 2f617b682..621052c96 100644 --- a/netbox/extras/forms/model_forms.py +++ b/netbox/extras/forms/model_forms.py @@ -1,6 +1,7 @@ import json from django import forms +from django.conf import settings from django.db.models import Q from django.contrib.contenttypes.models import ContentType from django.utils.translation import gettext as _ @@ -10,17 +11,20 @@ from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site from extras.choices import * from extras.models import * from extras.utils import FeatureQuery +from netbox.config import get_config, PARAMS from netbox.forms import NetBoxModelForm from tenancy.models import Tenant, TenantGroup -from utilities.forms import BootstrapMixin, add_blank_choice +from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, BootstrapMixin, add_blank_choice from utilities.forms.fields import ( CommentField, ContentTypeChoiceField, ContentTypeMultipleChoiceField, DynamicModelMultipleChoiceField, JSONField, SlugField, ) from virtualization.models import Cluster, ClusterGroup, ClusterType + __all__ = ( 'ConfigContextForm', + 'ConfigRevisionForm', 'ConfigTemplateForm', 'CustomFieldForm', 'CustomLinkForm', @@ -374,3 +378,99 @@ class JournalEntryForm(NetBoxModelForm): 'assigned_object_type': forms.HiddenInput, 'assigned_object_id': forms.HiddenInput, } + + +EMPTY_VALUES = ('', None, [], ()) + + +class ConfigFormMetaclass(forms.models.ModelFormMetaclass): + + def __new__(mcs, name, bases, attrs): + + # Emulate a declared field for each supported configuration parameter + param_fields = {} + for param in PARAMS: + field_kwargs = { + 'required': False, + 'label': param.label, + 'help_text': param.description, + } + field_kwargs.update(**param.field_kwargs) + param_fields[param.name] = param.field(**field_kwargs) + attrs.update(param_fields) + + return super().__new__(mcs, name, bases, attrs) + + +class ConfigRevisionForm(BootstrapMixin, forms.ModelForm, metaclass=ConfigFormMetaclass): + """ + Form for creating a new ConfigRevision. + """ + + fieldsets = ( + ('Rack Elevations', ('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH')), + ('Power', ('POWERFEED_DEFAULT_VOLTAGE', 'POWERFEED_DEFAULT_AMPERAGE', 'POWERFEED_DEFAULT_MAX_UTILIZATION')), + ('IPAM', ('ENFORCE_GLOBAL_UNIQUE', 'PREFER_IPV4')), + ('Security', ('ALLOWED_URL_SCHEMES',)), + ('Banners', ('BANNER_LOGIN', 'BANNER_MAINTENANCE', 'BANNER_TOP', 'BANNER_BOTTOM')), + ('Pagination', ('PAGINATE_COUNT', 'MAX_PAGE_SIZE')), + ('Validation', ('CUSTOM_VALIDATORS',)), + ('User Preferences', ('DEFAULT_USER_PREFERENCES',)), + ('Miscellaneous', ('MAINTENANCE_MODE', 'GRAPHQL_ENABLED', 'CHANGELOG_RETENTION', 'JOB_RETENTION', 'MAPS_URL')), + ('Config Revision', ('comment',)) + ) + + class Meta: + model = ConfigRevision + fields = '__all__' + widgets = { + 'BANNER_LOGIN': forms.Textarea(attrs={'class': 'font-monospace'}), + 'BANNER_MAINTENANCE': forms.Textarea(attrs={'class': 'font-monospace'}), + 'BANNER_TOP': forms.Textarea(attrs={'class': 'font-monospace'}), + 'BANNER_BOTTOM': forms.Textarea(attrs={'class': 'font-monospace'}), + 'CUSTOM_VALIDATORS': forms.Textarea(attrs={'class': 'font-monospace'}), + 'comment': forms.Textarea(), + } + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + # Append current parameter values to form field help texts and check for static configurations + config = get_config() + for param in PARAMS: + value = getattr(config, param.name) + is_static = hasattr(settings, param.name) + if value: + help_text = self.fields[param.name].help_text + if help_text: + help_text += '
' # Line break + help_text += f'Current value: {value}' + if is_static: + help_text += ' (defined statically)' + elif value == param.default: + help_text += ' (default)' + self.fields[param.name].help_text = help_text + self.fields[param.name].initial = value + if is_static: + self.fields[param.name].disabled = True + + def save(self, commit=True): + instance = super().save(commit=False) + + # Populate JSON data on the instance + instance.data = self.render_json() + + if commit: + instance.save() + + return instance + + def render_json(self): + json = {} + + # Iterate through each field and populate non-empty values + for field_name in self.declared_fields: + if field_name in self.cleaned_data and self.cleaned_data[field_name] not in EMPTY_VALUES: + json[field_name] = self.cleaned_data[field_name] + + return json diff --git a/netbox/extras/migrations/0093_configrevision_ordering.py b/netbox/extras/migrations/0093_configrevision_ordering.py new file mode 100644 index 000000000..a4e875e6d --- /dev/null +++ b/netbox/extras/migrations/0093_configrevision_ordering.py @@ -0,0 +1,17 @@ +# Generated by Django 4.1.9 on 2023-06-22 14:14 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0092_delete_jobresult'), + ] + + operations = [ + migrations.AlterModelOptions( + name='configrevision', + options={'ordering': ['-created']}, + ), + ] diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index 6c7aac08d..0cbc7a1de 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -612,6 +612,11 @@ class ConfigRevision(models.Model): verbose_name='Configuration data' ) + objects = RestrictedQuerySet.as_manager() + + class Meta: + ordering = ['-created'] + def __str__(self): return f'Config revision #{self.pk} ({self.created})' @@ -620,6 +625,9 @@ class ConfigRevision(models.Model): return self.data[item] return super().__getattribute__(item) + def get_absolute_url(self): + return reverse('extras:configrevision', args=[self.pk]) + def activate(self): """ Cache the configuration data. diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py index 9e4924532..e41bc9126 100644 --- a/netbox/extras/tables/tables.py +++ b/netbox/extras/tables/tables.py @@ -9,6 +9,7 @@ from .template_code import * __all__ = ( 'ConfigContextTable', + 'ConfigRevisionTable', 'ConfigTemplateTable', 'CustomFieldTable', 'CustomLinkTable', @@ -30,6 +31,29 @@ IMAGEATTACHMENT_IMAGE = ''' {% endif %} ''' +REVISION_BUTTONS = """ +{% if not record.is_active %} + + + +{% endif %} +""" + + +class ConfigRevisionTable(NetBoxTable): + is_active = columns.BooleanColumn() + actions = columns.ActionsColumn( + actions=('delete',), + extra_buttons=REVISION_BUTTONS + ) + + class Meta(NetBoxTable.Meta): + model = ConfigRevision + fields = ( + 'pk', 'id', 'is_active', 'created', 'comment', + ) + default_columns = ('pk', 'id', 'is_active', 'created', 'comment') + class CustomFieldTable(NetBoxTable): name = tables.Column( diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py index c4fc3d938..b3909391a 100644 --- a/netbox/extras/urls.py +++ b/netbox/extras/urls.py @@ -85,6 +85,13 @@ urlpatterns = [ path('journal-entries/import/', views.JournalEntryBulkImportView.as_view(), name='journalentry_import'), path('journal-entries/
Restore configuration #{{ object.pk }} from {{ object.created }}?
- -| Parameter | -Current Value | -New Value | -- | {{ param }} | -{{ current }} | -{{ new }} | -{% if current != new %} {% endif %} |
-
- {% endfor %}
-
|---|
+
+{% endblock controls %}
+
+{% block content %}
+
+ {% plugin_buttons object %}
+
+
+ {% custom_links object %}
+
+
+
+{% endblock %}
diff --git a/netbox/templates/extras/configrevision_restore.html b/netbox/templates/extras/configrevision_restore.html
new file mode 100644
index 000000000..ac22f8cbd
--- /dev/null
+++ b/netbox/templates/extras/configrevision_restore.html
@@ -0,0 +1,88 @@
+{% extends 'base/layout.html' %}
+{% load helpers %}
+{% load buttons %}
+{% load perms %}
+{% load static %}
+
+{% block title %}Restore: {{ object }}{% endblock %}
+
+{% block subtitle %}
+
+
+
+
+
+ Rack Elevation
+
+
+
+
+ | Rack elevation default unit height: | +{{ object.data.RACK_ELEVATION_DEFAULT_UNIT_HEIGHT }} | +
|---|---|
| Rack elevation default unit width: | +{{ object.data.RACK_ELEVATION_DEFAULT_UNIT_WIDTH }} | +
+
+
+ Power
+
+
+
+
+ | Powerfeed default voltage: | +{{ object.data.POWERFEED_DEFAULT_VOLTAGE }} | +
|---|---|
| Powerfeed default amperage: | +{{ object.data.POWERFEED_DEFAULT_AMPERAGE }} | +
| Powerfeed default max utilization: | +{{ object.data.POWERFEED_DEFAULT_MAX_UTILIZATION }} | +
+
+
+ IPAM
+
+
+
+
+ | IPAM enforce global unique: | +{{ object.data.ENFORCE_GLOBAL_UNIQUE }} | +
|---|---|
| IPAM prefer IPV4: | +{{ object.data.PREFER_IPV4 }} | +
+
+
+ Security
+
+
+
+
+ | Allowed URL schemes: | +{{ object.data.ALLOWED_URL_SCHEMES }} | +
|---|
+
+
+
+ Banners
+
+
+
+
+ | Login banner: | +{{ object.data.BANNER_LOGIN }} | +
|---|---|
| Maintenance banner: | +{{ object.data.BANNER_MAINTENANCE }} | +
| Top banner: | +{{ object.data.BANNER_TOP }} | +
| Bottom banner: | +{{ object.data.BANNER_BOTTOM }} | +
+
+
+
+
+
+ Pagination
+
+
+
+
+ | Paginate count: | +{{ object.data.PAGINATE_COUNT }} | +
|---|---|
| Max page size: | +{{ object.data.MAX_PAGE_SIZE }} | +
+
+
+ Validation
+
+
+
+
+ | Custom validators: | +{{ object.data.CUSTOM_VALIDATORS }} | +
|---|
+
+
+ User Preferences
+
+
+
+
+ | Default user preferences: | +{{ object.data.DEFAULT_USER_PREFERENCES }} | +
|---|
+
+
+ Miscellaneous
+
+
+
+
+ | Maintenance mode: | +{{ object.data.MAINTENANCE_MODE }} | +
|---|---|
| GraphQL enabled: | +{{ object.data.GRAPHQL_ENABLED }} | +
| Changelog retention: | +{{ object.data.CHANGELOG_RETENTION }} | +
| Job retention: | +{{ object.data.JOB_RETENTION }} | +
| Maps URL: | +{{ object.data.MAPS_URL }} | +
+
+
+ Config Revision
+
+
+
+
+ | Comment: | +{{ object.comment }} | +
|---|
+ Created {{ object.created|annotated_date }}
+
+{% endblock %}
+
+{% block header %}
+
+ {{ block.super }}
+{% endblock header %}
+
+{% block controls %}
+
+
+{% endblock controls %}
+
+{% block tabs %}
+
+{% endblock %}
+
+{% block content %}
+
+ {% if request.user|can_delete:job %}
+ {% delete_button job %}
+ {% endif %}
+
+
+
+
+
+
+{% endblock content %}
+
+{% block modals %}
+{% endblock modals %}
diff --git a/netbox/templates/generic/object.html b/netbox/templates/generic/object.html
index d3a617455..ebbeb2dfc 100644
--- a/netbox/templates/generic/object.html
+++ b/netbox/templates/generic/object.html
@@ -38,7 +38,7 @@ Context:
{{ block.super }}
-{% endblock %}
+{% endblock header %}
{% block title %}{{ object }}{% endblock %}
@@ -48,7 +48,7 @@ Context:
·
Updated {{ object.last_updated|timesince }} ago
-{% endblock %}
+{% endblock subtitle %}
{% block controls %}
{# Clone/Edit/Delete Buttons #}
+
+
+
+
+ | Parameter | +Current Value | +New Value | ++ | {{ param }} | +{{ current }} | +{{ new }} | +{% if current != new %}{% endif %} |
+
+ {% endfor %}
+
|---|