From 7c6faff405d4c4a0877362a048ccc9313e671cbf Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 6 May 2020 23:50:41 -0400 Subject: [PATCH 01/19] Post-release version bump --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 415c556e9..f928ca71e 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.8.3' +VERSION = '2.8.4-dev' # Hostname HOSTNAME = platform.node() From b7a96a33efe25e84a0e8ffebc3d3280dda0ae9c9 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 7 May 2020 10:34:33 -0400 Subject: [PATCH 02/19] Fixes #4598: Display error message when invalid cable length is specified --- docs/release-notes/version-2.8.md | 8 ++++++++ netbox/dcim/forms.py | 5 +++++ netbox/templates/dcim/inc/cable_form.html | 14 ++++++++++++++ 3 files changed, 27 insertions(+) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index e3bd6b512..e1dfaddbb 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -1,5 +1,13 @@ # NetBox v2.8 +v2.8.4 (FUTURE) + +### Bug Fixes + +* [#4598](https://github.com/netbox-community/netbox/issues/4598) - Display error message when invalid cable length is specified + +--- + ## v2.8.3 (2020-05-06) ### Bug Fixes diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index b104124b4..2116d0948 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -3659,6 +3659,11 @@ class CableForm(BootstrapMixin, forms.ModelForm): 'type': StaticSelect2, 'length_unit': StaticSelect2, } + error_messages = { + 'length': { + 'max_value': 'Maximum length is 32767 (any unit)' + } + } class CableCSVForm(CSVModelForm): diff --git a/netbox/templates/dcim/inc/cable_form.html b/netbox/templates/dcim/inc/cable_form.html index 0799eb130..a52cc302e 100644 --- a/netbox/templates/dcim/inc/cable_form.html +++ b/netbox/templates/dcim/inc/cable_form.html @@ -10,9 +10,23 @@
{{ form.length }} + {% if form.length.errors %} +
    + {% for error in form.length.errors %} +
  • {{ error }}
    • + {% endfor %} +
+ {% endif %}
{{ form.length_unit }} + {% if form.length_unit.errors %} +
    + {% for error in form.length_unit.errors %} +
  • {{ error }}
    • + {% endfor %} +
+ {% endif %}
From e14e217fcd2544441fce3028b7ea2f37fa55cc18 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 7 May 2020 16:22:04 -0400 Subject: [PATCH 03/19] Fixes #4604: Multi-position rear ports may only be connected to other rear ports --- docs/release-notes/version-2.8.md | 1 + netbox/dcim/models/__init__.py | 30 ++++++++++++++++++------------ 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index e1dfaddbb..ff6ba4e50 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -5,6 +5,7 @@ v2.8.4 (FUTURE) ### Bug Fixes * [#4598](https://github.com/netbox-community/netbox/issues/4598) - Display error message when invalid cable length is specified +* [#4604](https://github.com/netbox-community/netbox/issues/4604) - Multi-position rear ports may only be connected to other rear ports --- diff --git a/netbox/dcim/models/__init__.py b/netbox/dcim/models/__init__.py index b0da352da..490667153 100644 --- a/netbox/dcim/models/__init__.py +++ b/netbox/dcim/models/__init__.py @@ -2182,23 +2182,29 @@ class Cable(ChangeLoggedModel): # Check that termination types are compatible if type_b not in COMPATIBLE_TERMINATION_TYPES.get(type_a): - raise ValidationError("Incompatible termination types: {} and {}".format( - self.termination_a_type, self.termination_b_type - )) + raise ValidationError( + f"Incompatible termination types: {self.termination_a_type} and {self.termination_b_type}" + ) - # A RearPort with multiple positions must be connected to a component with an equal number of positions - if isinstance(self.termination_a, RearPort) and isinstance(self.termination_b, RearPort): - if self.termination_a.positions != self.termination_b.positions: - raise ValidationError( - "{} has {} positions and {} has {}. Both terminations must have the same number of positions.".format( - self.termination_a, self.termination_a.positions, - self.termination_b, self.termination_b.positions + # A RearPort with multiple positions must be connected to a RearPort with an equal number of positions + for term_a, term_b in [ + (self.termination_a, self.termination_b), + (self.termination_b, self.termination_a) + ]: + if isinstance(term_a, RearPort) and term_a.positions > 1: + if not isinstance(term_b, RearPort): + raise ValidationError( + "Rear ports with multiple positions may only be connected to other rear ports" + ) + elif term_a.positions != term_b.positions: + raise ValidationError( + f"{term_a} has {term_a.positions} position(s) but {term_b} has {term_b.positions}. " + f"Both terminations must have the same number of positions." ) - ) # A termination point cannot be connected to itself if self.termination_a == self.termination_b: - raise ValidationError("Cannot connect {} to itself".format(self.termination_a_type)) + raise ValidationError(f"Cannot connect {self.termination_a_type} to itself") # A front port cannot be connected to its corresponding rear port if ( From da8380c62cd9ef256dc3017fc991d7061d1e2199 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 7 May 2020 16:59:27 -0400 Subject: [PATCH 04/19] Refactor extras.models --- .../migrations/0006_add_imageattachments.py | 4 +- .../migrations/0007_unicode_literals.py | 4 +- netbox/extras/models/__init__.py | 25 ++ netbox/extras/models/customfields.py | 297 ++++++++++++++ netbox/extras/{ => models}/models.py | 374 +----------------- netbox/extras/models/tags.py | 44 +++ netbox/extras/utils.py | 16 + 7 files changed, 390 insertions(+), 374 deletions(-) create mode 100644 netbox/extras/models/__init__.py create mode 100644 netbox/extras/models/customfields.py rename netbox/extras/{ => models}/models.py (63%) create mode 100644 netbox/extras/models/tags.py diff --git a/netbox/extras/migrations/0006_add_imageattachments.py b/netbox/extras/migrations/0006_add_imageattachments.py index 6842cced0..b25327c33 100644 --- a/netbox/extras/migrations/0006_add_imageattachments.py +++ b/netbox/extras/migrations/0006_add_imageattachments.py @@ -2,7 +2,7 @@ # Generated by Django 1.11 on 2017-04-04 19:58 from django.db import migrations, models import django.db.models.deletion -import extras.models +import extras.utils class Migration(migrations.Migration): @@ -18,7 +18,7 @@ class Migration(migrations.Migration): fields=[ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), ('object_id', models.PositiveIntegerField()), - ('image', models.ImageField(height_field=b'image_height', upload_to=extras.models.image_upload, width_field=b'image_width')), + ('image', models.ImageField(height_field=b'image_height', upload_to=extras.utils.image_upload, width_field=b'image_width')), ('image_height', models.PositiveSmallIntegerField()), ('image_width', models.PositiveSmallIntegerField()), ('name', models.CharField(blank=True, max_length=50)), diff --git a/netbox/extras/migrations/0007_unicode_literals.py b/netbox/extras/migrations/0007_unicode_literals.py index fecb33b7b..88525a24a 100644 --- a/netbox/extras/migrations/0007_unicode_literals.py +++ b/netbox/extras/migrations/0007_unicode_literals.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # Generated by Django 1.11 on 2017-05-24 15:34 from django.db import migrations, models -import extras.models +import extras.utils class Migration(migrations.Migration): @@ -74,7 +74,7 @@ class Migration(migrations.Migration): migrations.AlterField( model_name='imageattachment', name='image', - field=models.ImageField(height_field='image_height', upload_to=extras.models.image_upload, width_field='image_width'), + field=models.ImageField(height_field='image_height', upload_to=extras.utils.image_upload, width_field='image_width'), ), migrations.AlterField( model_name='topologymap', diff --git a/netbox/extras/models/__init__.py b/netbox/extras/models/__init__.py new file mode 100644 index 000000000..2942bfa48 --- /dev/null +++ b/netbox/extras/models/__init__.py @@ -0,0 +1,25 @@ +from .customfields import CustomField, CustomFieldChoice, CustomFieldModel, CustomFieldValue +from .models import ( + ConfigContext, ConfigContextModel, CustomLink, ExportTemplate, Graph, ImageAttachment, ObjectChange, ReportResult, + Script, Webhook, +) +from .tags import Tag, TaggedItem + +__all__ = ( + 'ConfigContext', + 'ConfigContextModel', + 'CustomField', + 'CustomFieldChoice', + 'CustomFieldModel', + 'CustomFieldValue', + 'CustomLink', + 'ExportTemplate', + 'Graph', + 'ImageAttachment', + 'ObjectChange', + 'ReportResult', + 'Script', + 'Tag', + 'TaggedItem', + 'Webhook', +) diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py new file mode 100644 index 000000000..47bccd98a --- /dev/null +++ b/netbox/extras/models/customfields.py @@ -0,0 +1,297 @@ +from collections import OrderedDict +from datetime import date + +from django import forms +from django.contrib.contenttypes.fields import GenericForeignKey +from django.contrib.contenttypes.models import ContentType +from django.core.validators import ValidationError +from django.db import models + +from utilities.forms import CSVChoiceField, DatePicker, LaxURLField, StaticSelect2, add_blank_choice +from extras.choices import * +from extras.utils import FeatureQuery + + +# +# Custom fields +# + +class CustomFieldModel(models.Model): + _cf = None + + class Meta: + abstract = True + + def cache_custom_fields(self): + """ + Cache all custom field values for this instance + """ + self._cf = { + field.name: value for field, value in self.get_custom_fields().items() + } + + @property + def cf(self): + """ + Name-based CustomFieldValue accessor for use in templates + """ + if self._cf is None: + self.cache_custom_fields() + return self._cf + + def get_custom_fields(self): + """ + Return a dictionary of custom fields for a single object in the form {: value}. + """ + + # Find all custom fields applicable to this type of object + content_type = ContentType.objects.get_for_model(self) + fields = CustomField.objects.filter(obj_type=content_type) + + # If the object exists, populate its custom fields with values + if hasattr(self, 'pk'): + values = self.custom_field_values.all() + values_dict = {cfv.field_id: cfv.value for cfv in values} + return OrderedDict([(field, values_dict.get(field.pk)) for field in fields]) + else: + return OrderedDict([(field, None) for field in fields]) + + +class CustomField(models.Model): + obj_type = models.ManyToManyField( + to=ContentType, + related_name='custom_fields', + verbose_name='Object(s)', + limit_choices_to=FeatureQuery('custom_fields'), + help_text='The object(s) to which this field applies.' + ) + type = models.CharField( + max_length=50, + choices=CustomFieldTypeChoices, + default=CustomFieldTypeChoices.TYPE_TEXT + ) + name = models.CharField( + max_length=50, + unique=True + ) + label = models.CharField( + max_length=50, + blank=True, + help_text='Name of the field as displayed to users (if not provided, ' + 'the field\'s name will be used)' + ) + description = models.CharField( + max_length=200, + blank=True + ) + required = models.BooleanField( + default=False, + help_text='If true, this field is required when creating new objects ' + 'or editing an existing object.' + ) + filter_logic = models.CharField( + max_length=50, + choices=CustomFieldFilterLogicChoices, + default=CustomFieldFilterLogicChoices.FILTER_LOOSE, + help_text='Loose matches any instance of a given string; exact ' + 'matches the entire field.' + ) + default = models.CharField( + max_length=100, + blank=True, + help_text='Default value for the field. Use "true" or "false" for booleans.' + ) + weight = models.PositiveSmallIntegerField( + default=100, + help_text='Fields with higher weights appear lower in a form.' + ) + + class Meta: + ordering = ['weight', 'name'] + + def __str__(self): + return self.label or self.name.replace('_', ' ').capitalize() + + def serialize_value(self, value): + """ + Serialize the given value to a string suitable for storage as a CustomFieldValue + """ + if value is None: + return '' + if self.type == CustomFieldTypeChoices.TYPE_BOOLEAN: + return str(int(bool(value))) + if self.type == CustomFieldTypeChoices.TYPE_DATE: + # Could be date/datetime object or string + try: + return value.strftime('%Y-%m-%d') + except AttributeError: + return value + if self.type == CustomFieldTypeChoices.TYPE_SELECT: + # Could be ModelChoiceField or TypedChoiceField + return str(value.id) if hasattr(value, 'id') else str(value) + return value + + def deserialize_value(self, serialized_value): + """ + Convert a string into the object it represents depending on the type of field + """ + if serialized_value == '': + return None + if self.type == CustomFieldTypeChoices.TYPE_INTEGER: + return int(serialized_value) + if self.type == CustomFieldTypeChoices.TYPE_BOOLEAN: + return bool(int(serialized_value)) + if self.type == CustomFieldTypeChoices.TYPE_DATE: + # Read date as YYYY-MM-DD + return date(*[int(n) for n in serialized_value.split('-')]) + if self.type == CustomFieldTypeChoices.TYPE_SELECT: + return self.choices.get(pk=int(serialized_value)) + return serialized_value + + def to_form_field(self, set_initial=True, enforce_required=True, for_csv_import=False): + """ + Return a form field suitable for setting a CustomField's value for an object. + + set_initial: Set initial date for the field. This should be False when generating a field for bulk editing. + enforce_required: Honor the value of CustomField.required. Set to False for filtering/bulk editing. + for_csv_import: Return a form field suitable for bulk import of objects in CSV format. + """ + initial = self.default if set_initial else None + required = self.required if enforce_required else False + + # Integer + if self.type == CustomFieldTypeChoices.TYPE_INTEGER: + field = forms.IntegerField(required=required, initial=initial) + + # Boolean + elif self.type == CustomFieldTypeChoices.TYPE_BOOLEAN: + choices = ( + (None, '---------'), + (1, 'True'), + (0, 'False'), + ) + if initial is not None and initial.lower() in ['true', 'yes', '1']: + initial = 1 + elif initial is not None and initial.lower() in ['false', 'no', '0']: + initial = 0 + else: + initial = None + field = forms.NullBooleanField( + required=required, initial=initial, widget=StaticSelect2(choices=choices) + ) + + # Date + elif self.type == CustomFieldTypeChoices.TYPE_DATE: + field = forms.DateField(required=required, initial=initial, widget=DatePicker()) + + # Select + elif self.type == CustomFieldTypeChoices.TYPE_SELECT: + choices = [(cfc.pk, cfc.value) for cfc in self.choices.all()] + + if not required: + choices = add_blank_choice(choices) + + # Set the initial value to the PK of the default choice, if any + if set_initial: + default_choice = self.choices.filter(value=self.default).first() + if default_choice: + initial = default_choice.pk + + field_class = CSVChoiceField if for_csv_import else forms.ChoiceField + field = field_class( + choices=choices, required=required, initial=initial, widget=StaticSelect2() + ) + + # URL + elif self.type == CustomFieldTypeChoices.TYPE_URL: + field = LaxURLField(required=required, initial=initial) + + # Text + else: + field = forms.CharField(max_length=255, required=required, initial=initial) + + field.model = self + field.label = self.label if self.label else self.name.replace('_', ' ').capitalize() + if self.description: + field.help_text = self.description + + return field + + +class CustomFieldValue(models.Model): + field = models.ForeignKey( + to='extras.CustomField', + on_delete=models.CASCADE, + related_name='values' + ) + obj_type = models.ForeignKey( + to=ContentType, + on_delete=models.PROTECT, + related_name='+' + ) + obj_id = models.PositiveIntegerField() + obj = GenericForeignKey( + ct_field='obj_type', + fk_field='obj_id' + ) + serialized_value = models.CharField( + max_length=255 + ) + + class Meta: + ordering = ('obj_type', 'obj_id', 'pk') # (obj_type, obj_id) may be non-unique + unique_together = ('field', 'obj_type', 'obj_id') + + def __str__(self): + return '{} {}'.format(self.obj, self.field) + + @property + def value(self): + return self.field.deserialize_value(self.serialized_value) + + @value.setter + def value(self, value): + self.serialized_value = self.field.serialize_value(value) + + def save(self, *args, **kwargs): + # Delete this object if it no longer has a value to store + if self.pk and self.value is None: + self.delete() + else: + super().save(*args, **kwargs) + + +class CustomFieldChoice(models.Model): + field = models.ForeignKey( + to='extras.CustomField', + on_delete=models.CASCADE, + related_name='choices', + limit_choices_to={'type': CustomFieldTypeChoices.TYPE_SELECT} + ) + value = models.CharField( + max_length=100 + ) + weight = models.PositiveSmallIntegerField( + default=100, + help_text='Higher weights appear lower in the list' + ) + + class Meta: + ordering = ['field', 'weight', 'value'] + unique_together = ['field', 'value'] + + def __str__(self): + return self.value + + def clean(self): + if self.field.type != CustomFieldTypeChoices.TYPE_SELECT: + raise ValidationError("Custom field choices can only be assigned to selection fields.") + + def delete(self, using=None, keep_parents=False): + # When deleting a CustomFieldChoice, delete all CustomFieldValues which point to it + pk = self.pk + super().delete(using, keep_parents) + CustomFieldValue.objects.filter( + field__type=CustomFieldTypeChoices.TYPE_SELECT, + serialized_value=str(pk) + ).delete() diff --git a/netbox/extras/models.py b/netbox/extras/models/models.py similarity index 63% rename from netbox/extras/models.py rename to netbox/extras/models/models.py index 488554596..f98a7b34f 100644 --- a/netbox/extras/models.py +++ b/netbox/extras/models/models.py @@ -1,8 +1,6 @@ import json from collections import OrderedDict -from datetime import date -from django import forms from django.contrib.auth.models import User from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType @@ -12,37 +10,13 @@ from django.db import models from django.http import HttpResponse from django.template import Template, Context from django.urls import reverse -from django.utils.text import slugify from rest_framework.utils.encoders import JSONEncoder -from taggit.models import TagBase, GenericTaggedItemBase -from utilities.fields import ColorField -from utilities.forms import CSVChoiceField, DatePicker, LaxURLField, StaticSelect2, add_blank_choice from utilities.utils import deepmerge, render_jinja2 -from .choices import * -from .constants import * -from .querysets import ConfigContextQuerySet -from .utils import FeatureQuery - - -__all__ = ( - 'ConfigContext', - 'ConfigContextModel', - 'CustomField', - 'CustomFieldChoice', - 'CustomFieldModel', - 'CustomFieldValue', - 'CustomLink', - 'ExportTemplate', - 'Graph', - 'ImageAttachment', - 'ObjectChange', - 'ReportResult', - 'Script', - 'Tag', - 'TaggedItem', - 'Webhook', -) +from extras.choices import * +from extras.constants import * +from extras.querysets import ConfigContextQuerySet +from extras.utils import FeatureQuery, image_upload # @@ -174,291 +148,6 @@ class Webhook(models.Model): return json.dumps(context, cls=JSONEncoder) -# -# Custom fields -# - -class CustomFieldModel(models.Model): - _cf = None - - class Meta: - abstract = True - - def cache_custom_fields(self): - """ - Cache all custom field values for this instance - """ - self._cf = { - field.name: value for field, value in self.get_custom_fields().items() - } - - @property - def cf(self): - """ - Name-based CustomFieldValue accessor for use in templates - """ - if self._cf is None: - self.cache_custom_fields() - return self._cf - - def get_custom_fields(self): - """ - Return a dictionary of custom fields for a single object in the form {: value}. - """ - - # Find all custom fields applicable to this type of object - content_type = ContentType.objects.get_for_model(self) - fields = CustomField.objects.filter(obj_type=content_type) - - # If the object exists, populate its custom fields with values - if hasattr(self, 'pk'): - values = self.custom_field_values.all() - values_dict = {cfv.field_id: cfv.value for cfv in values} - return OrderedDict([(field, values_dict.get(field.pk)) for field in fields]) - else: - return OrderedDict([(field, None) for field in fields]) - - -class CustomField(models.Model): - obj_type = models.ManyToManyField( - to=ContentType, - related_name='custom_fields', - verbose_name='Object(s)', - limit_choices_to=FeatureQuery('custom_fields'), - help_text='The object(s) to which this field applies.' - ) - type = models.CharField( - max_length=50, - choices=CustomFieldTypeChoices, - default=CustomFieldTypeChoices.TYPE_TEXT - ) - name = models.CharField( - max_length=50, - unique=True - ) - label = models.CharField( - max_length=50, - blank=True, - help_text='Name of the field as displayed to users (if not provided, ' - 'the field\'s name will be used)' - ) - description = models.CharField( - max_length=200, - blank=True - ) - required = models.BooleanField( - default=False, - help_text='If true, this field is required when creating new objects ' - 'or editing an existing object.' - ) - filter_logic = models.CharField( - max_length=50, - choices=CustomFieldFilterLogicChoices, - default=CustomFieldFilterLogicChoices.FILTER_LOOSE, - help_text='Loose matches any instance of a given string; exact ' - 'matches the entire field.' - ) - default = models.CharField( - max_length=100, - blank=True, - help_text='Default value for the field. Use "true" or "false" for booleans.' - ) - weight = models.PositiveSmallIntegerField( - default=100, - help_text='Fields with higher weights appear lower in a form.' - ) - - class Meta: - ordering = ['weight', 'name'] - - def __str__(self): - return self.label or self.name.replace('_', ' ').capitalize() - - def serialize_value(self, value): - """ - Serialize the given value to a string suitable for storage as a CustomFieldValue - """ - if value is None: - return '' - if self.type == CustomFieldTypeChoices.TYPE_BOOLEAN: - return str(int(bool(value))) - if self.type == CustomFieldTypeChoices.TYPE_DATE: - # Could be date/datetime object or string - try: - return value.strftime('%Y-%m-%d') - except AttributeError: - return value - if self.type == CustomFieldTypeChoices.TYPE_SELECT: - # Could be ModelChoiceField or TypedChoiceField - return str(value.id) if hasattr(value, 'id') else str(value) - return value - - def deserialize_value(self, serialized_value): - """ - Convert a string into the object it represents depending on the type of field - """ - if serialized_value == '': - return None - if self.type == CustomFieldTypeChoices.TYPE_INTEGER: - return int(serialized_value) - if self.type == CustomFieldTypeChoices.TYPE_BOOLEAN: - return bool(int(serialized_value)) - if self.type == CustomFieldTypeChoices.TYPE_DATE: - # Read date as YYYY-MM-DD - return date(*[int(n) for n in serialized_value.split('-')]) - if self.type == CustomFieldTypeChoices.TYPE_SELECT: - return self.choices.get(pk=int(serialized_value)) - return serialized_value - - def to_form_field(self, set_initial=True, enforce_required=True, for_csv_import=False): - """ - Return a form field suitable for setting a CustomField's value for an object. - - set_initial: Set initial date for the field. This should be False when generating a field for bulk editing. - enforce_required: Honor the value of CustomField.required. Set to False for filtering/bulk editing. - for_csv_import: Return a form field suitable for bulk import of objects in CSV format. - """ - initial = self.default if set_initial else None - required = self.required if enforce_required else False - - # Integer - if self.type == CustomFieldTypeChoices.TYPE_INTEGER: - field = forms.IntegerField(required=required, initial=initial) - - # Boolean - elif self.type == CustomFieldTypeChoices.TYPE_BOOLEAN: - choices = ( - (None, '---------'), - (1, 'True'), - (0, 'False'), - ) - if initial is not None and initial.lower() in ['true', 'yes', '1']: - initial = 1 - elif initial is not None and initial.lower() in ['false', 'no', '0']: - initial = 0 - else: - initial = None - field = forms.NullBooleanField( - required=required, initial=initial, widget=StaticSelect2(choices=choices) - ) - - # Date - elif self.type == CustomFieldTypeChoices.TYPE_DATE: - field = forms.DateField(required=required, initial=initial, widget=DatePicker()) - - # Select - elif self.type == CustomFieldTypeChoices.TYPE_SELECT: - choices = [(cfc.pk, cfc.value) for cfc in self.choices.all()] - - if not required: - choices = add_blank_choice(choices) - - # Set the initial value to the PK of the default choice, if any - if set_initial: - default_choice = self.choices.filter(value=self.default).first() - if default_choice: - initial = default_choice.pk - - field_class = CSVChoiceField if for_csv_import else forms.ChoiceField - field = field_class( - choices=choices, required=required, initial=initial, widget=StaticSelect2() - ) - - # URL - elif self.type == CustomFieldTypeChoices.TYPE_URL: - field = LaxURLField(required=required, initial=initial) - - # Text - else: - field = forms.CharField(max_length=255, required=required, initial=initial) - - field.model = self - field.label = self.label if self.label else self.name.replace('_', ' ').capitalize() - if self.description: - field.help_text = self.description - - return field - - -class CustomFieldValue(models.Model): - field = models.ForeignKey( - to='extras.CustomField', - on_delete=models.CASCADE, - related_name='values' - ) - obj_type = models.ForeignKey( - to=ContentType, - on_delete=models.PROTECT, - related_name='+' - ) - obj_id = models.PositiveIntegerField() - obj = GenericForeignKey( - ct_field='obj_type', - fk_field='obj_id' - ) - serialized_value = models.CharField( - max_length=255 - ) - - class Meta: - ordering = ('obj_type', 'obj_id', 'pk') # (obj_type, obj_id) may be non-unique - unique_together = ('field', 'obj_type', 'obj_id') - - def __str__(self): - return '{} {}'.format(self.obj, self.field) - - @property - def value(self): - return self.field.deserialize_value(self.serialized_value) - - @value.setter - def value(self, value): - self.serialized_value = self.field.serialize_value(value) - - def save(self, *args, **kwargs): - # Delete this object if it no longer has a value to store - if self.pk and self.value is None: - self.delete() - else: - super().save(*args, **kwargs) - - -class CustomFieldChoice(models.Model): - field = models.ForeignKey( - to='extras.CustomField', - on_delete=models.CASCADE, - related_name='choices', - limit_choices_to={'type': CustomFieldTypeChoices.TYPE_SELECT} - ) - value = models.CharField( - max_length=100 - ) - weight = models.PositiveSmallIntegerField( - default=100, - help_text='Higher weights appear lower in the list' - ) - - class Meta: - ordering = ['field', 'weight', 'value'] - unique_together = ['field', 'value'] - - def __str__(self): - return self.value - - def clean(self): - if self.field.type != CustomFieldTypeChoices.TYPE_SELECT: - raise ValidationError("Custom field choices can only be assigned to selection fields.") - - def delete(self, using=None, keep_parents=False): - # When deleting a CustomFieldChoice, delete all CustomFieldValues which point to it - pk = self.pk - super().delete(using, keep_parents) - CustomFieldValue.objects.filter( - field__type=CustomFieldTypeChoices.TYPE_SELECT, - serialized_value=str(pk) - ).delete() - - # # Custom links # @@ -663,20 +352,6 @@ class ExportTemplate(models.Model): # Image attachments # -def image_upload(instance, filename): - - path = 'image-attachments/' - - # Rename the file to the provided name, if any. Attempt to preserve the file extension. - extension = filename.rsplit('.')[-1].lower() - if instance.name and extension in ['bmp', 'gif', 'jpeg', 'jpg', 'png']: - filename = '.'.join([instance.name, extension]) - elif instance.name: - filename = instance.name - - return '{}{}_{}_{}'.format(path, instance.content_type.name, instance.object_id, filename) - - class ImageAttachment(models.Model): """ An uploaded image which is associated with an object. @@ -1038,44 +713,3 @@ class ObjectChange(models.Model): self.object_repr, self.object_data, ) - - -# -# Tags -# - -# TODO: figure out a way around this circular import for ObjectChange -from utilities.models import ChangeLoggedModel # noqa: E402 - - -class Tag(TagBase, ChangeLoggedModel): - color = ColorField( - default='9e9e9e' - ) - description = models.CharField( - max_length=200, - blank=True, - ) - - def get_absolute_url(self): - return reverse('extras:tag', args=[self.slug]) - - def slugify(self, tag, i=None): - # Allow Unicode in Tag slugs (avoids empty slugs for Tags with all-Unicode names) - slug = slugify(tag, allow_unicode=True) - if i is not None: - slug += "_%d" % i - return slug - - -class TaggedItem(GenericTaggedItemBase): - tag = models.ForeignKey( - to=Tag, - related_name="%(app_label)s_%(class)s_items", - on_delete=models.CASCADE - ) - - class Meta: - index_together = ( - ("content_type", "object_id") - ) diff --git a/netbox/extras/models/tags.py b/netbox/extras/models/tags.py new file mode 100644 index 000000000..3bad7fa8b --- /dev/null +++ b/netbox/extras/models/tags.py @@ -0,0 +1,44 @@ +from django.db import models +from django.urls import reverse +from django.utils.text import slugify +from taggit.models import TagBase, GenericTaggedItemBase + +from utilities.fields import ColorField +from utilities.models import ChangeLoggedModel + + +# +# Tags +# + +class Tag(TagBase, ChangeLoggedModel): + color = ColorField( + default='9e9e9e' + ) + description = models.CharField( + max_length=200, + blank=True, + ) + + def get_absolute_url(self): + return reverse('extras:tag', args=[self.slug]) + + def slugify(self, tag, i=None): + # Allow Unicode in Tag slugs (avoids empty slugs for Tags with all-Unicode names) + slug = slugify(tag, allow_unicode=True) + if i is not None: + slug += "_%d" % i + return slug + + +class TaggedItem(GenericTaggedItemBase): + tag = models.ForeignKey( + to=Tag, + related_name="%(app_label)s_%(class)s_items", + on_delete=models.CASCADE + ) + + class Meta: + index_together = ( + ("content_type", "object_id") + ) diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py index 78214fe41..edbd509f1 100644 --- a/netbox/extras/utils.py +++ b/netbox/extras/utils.py @@ -22,6 +22,22 @@ def is_taggable(obj): return False +def image_upload(instance, filename): + """ + Return a path for uploading image attchments. + """ + path = 'image-attachments/' + + # Rename the file to the provided name, if any. Attempt to preserve the file extension. + extension = filename.rsplit('.')[-1].lower() + if instance.name and extension in ['bmp', 'gif', 'jpeg', 'jpg', 'png']: + filename = '.'.join([instance.name, extension]) + elif instance.name: + filename = instance.name + + return '{}{}_{}_{}'.format(path, instance.content_type.name, instance.object_id, filename) + + @deconstructible class FeatureQuery: """ From 2c19390d7c69c3c930def43153567b3cd807a379 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 7 May 2020 17:20:32 -0400 Subject: [PATCH 05/19] Introduce CustomFieldManager (WIP) --- .../migrations/0042_customfield_manager.py | 20 ++++++++++ netbox/extras/models/customfields.py | 38 +++++++++++++++++-- 2 files changed, 54 insertions(+), 4 deletions(-) create mode 100644 netbox/extras/migrations/0042_customfield_manager.py diff --git a/netbox/extras/migrations/0042_customfield_manager.py b/netbox/extras/migrations/0042_customfield_manager.py new file mode 100644 index 000000000..7d80b567a --- /dev/null +++ b/netbox/extras/migrations/0042_customfield_manager.py @@ -0,0 +1,20 @@ +# Generated by Django 3.0.5 on 2020-05-07 21:06 + +from django.db import migrations +import extras.models.customfields + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0041_tag_description'), + ] + + operations = [ + migrations.AlterModelManagers( + name='customfield', + managers=[ + ('objects', extras.models.customfields.CustomFieldManager()), + ], + ), + ] diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index 47bccd98a..f00a52a5d 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -43,10 +43,7 @@ class CustomFieldModel(models.Model): """ Return a dictionary of custom fields for a single object in the form {: value}. """ - - # Find all custom fields applicable to this type of object - content_type = ContentType.objects.get_for_model(self) - fields = CustomField.objects.filter(obj_type=content_type) + fields = CustomField.objects.get_for_model(self) # If the object exists, populate its custom fields with values if hasattr(self, 'pk'): @@ -57,6 +54,37 @@ class CustomFieldModel(models.Model): return OrderedDict([(field, None) for field in fields]) +class CustomFieldManager(models.Manager): + use_in_migrations = True + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + # Initialize a cache for fetched CustomFields + self._cache = {} + + def get_for_model(self, model): + """ + Return all CustomFields assigned to the given model. + """ + model = model._meta.concrete_model + + # First try to return from cache + try: + return self._cache[model] + except KeyError: + pass + + # Fetch from the database if the model's CustomFields have not been cached + content_type = ContentType.objects.get_for_model(model) + customfields = CustomField.objects.filter(obj_type=content_type) + + # Cache the retrieved CustomFields + self._cache[model] = customfields + + return customfields + + class CustomField(models.Model): obj_type = models.ManyToManyField( to=ContentType, @@ -106,6 +134,8 @@ class CustomField(models.Model): help_text='Fields with higher weights appear lower in a form.' ) + objects = CustomFieldManager() + class Meta: ordering = ['weight', 'name'] From e3be5f84684b9c0f032d6aea830a1792b38db411 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 8 May 2020 10:05:05 -0400 Subject: [PATCH 06/19] Remove local caching attempt --- netbox/extras/models/customfields.py | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index f00a52a5d..f3e217039 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -1,3 +1,4 @@ +import logging from collections import OrderedDict from datetime import date @@ -57,31 +58,16 @@ class CustomFieldModel(models.Model): class CustomFieldManager(models.Manager): use_in_migrations = True - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - - # Initialize a cache for fetched CustomFields - self._cache = {} - def get_for_model(self, model): """ Return all CustomFields assigned to the given model. """ model = model._meta.concrete_model - # First try to return from cache - try: - return self._cache[model] - except KeyError: - pass - # Fetch from the database if the model's CustomFields have not been cached content_type = ContentType.objects.get_for_model(model) customfields = CustomField.objects.filter(obj_type=content_type) - # Cache the retrieved CustomFields - self._cache[model] = customfields - return customfields From 745c9a9c2b8cb1286dad19314f3b08d17c56f057 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 8 May 2020 12:18:08 -0400 Subject: [PATCH 07/19] Add test for CustomFieldManager.get_for_model() --- netbox/extras/models/customfields.py | 9 ++------- netbox/extras/tests/test_customfields.py | 13 +++++++++++++ 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index f3e217039..62e2ca4df 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -62,13 +62,8 @@ class CustomFieldManager(models.Manager): """ Return all CustomFields assigned to the given model. """ - model = model._meta.concrete_model - - # Fetch from the database if the model's CustomFields have not been cached - content_type = ContentType.objects.get_for_model(model) - customfields = CustomField.objects.filter(obj_type=content_type) - - return customfields + content_type = ContentType.objects.get_for_model(model._meta.concrete_model) + return self.get_queryset().filter(obj_type=content_type) class CustomField(models.Model): diff --git a/netbox/extras/tests/test_customfields.py b/netbox/extras/tests/test_customfields.py index d76532437..c94d8cd3f 100644 --- a/netbox/extras/tests/test_customfields.py +++ b/netbox/extras/tests/test_customfields.py @@ -99,6 +99,19 @@ class CustomFieldTest(TestCase): cf.delete() +class CustomFieldManagerTest(TestCase): + + def setUp(self): + content_type = ContentType.objects.get_for_model(Site) + custom_field = CustomField(type=CustomFieldTypeChoices.TYPE_TEXT, name='text_field', default='foo') + custom_field.save() + custom_field.obj_type.set([content_type]) + + def test_get_for_model(self): + self.assertEqual(CustomField.objects.get_for_model(Site).count(), 1) + self.assertEqual(CustomField.objects.get_for_model(VirtualMachine).count(), 0) + + class CustomFieldAPITest(APITestCase): @classmethod From 465d3ae1af4e4129d091776ed1e68d64e12bceeb Mon Sep 17 00:00:00 2001 From: kobayashi Date: Sat, 9 May 2020 23:06:24 -0400 Subject: [PATCH 08/19] Fix: 4607 Missing token context help --- docs/api/authentication.md | 13 +------------ docs/models/users/token.md | 12 ++++++++++++ docs/release-notes/version-2.8.md | 1 + 3 files changed, 14 insertions(+), 12 deletions(-) create mode 100644 docs/models/users/token.md diff --git a/docs/api/authentication.md b/docs/api/authentication.md index 8e38c4de9..e8e6ddc96 100644 --- a/docs/api/authentication.md +++ b/docs/api/authentication.md @@ -2,18 +2,7 @@ The NetBox API employs token-based authentication. For convenience, cookie authentication can also be used when navigating the browsable API. -## Tokens - -A token is a unique identifier that identifies a user to the API. Each user in NetBox may have one or more tokens which he or she can use to authenticate to the API. To create a token, navigate to the API tokens page at `/user/api-tokens/`. - -!!! note - The creation and modification of API tokens can be restricted per user by an administrator. If you don't see an option to create an API token, ask an administrator to grant you access. - -Each token contains a 160-bit key represented as 40 hexadecimal characters. When creating a token, you'll typically leave the key field blank so that a random key will be automatically generated. However, NetBox allows you to specify a key in case you need to restore a previously deleted token to operation. - -By default, a token can be used for all operations available via the API. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only. - -Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. +{!docs/models/users/token.md!} ## Authenticating to the API diff --git a/docs/models/users/token.md b/docs/models/users/token.md new file mode 100644 index 000000000..bbeb2284b --- /dev/null +++ b/docs/models/users/token.md @@ -0,0 +1,12 @@ +## Tokens + +A token is a unique identifier that identifies a user to the API. Each user in NetBox may have one or more tokens which he or she can use to authenticate to the API. To create a token, navigate to the API tokens page at `/user/api-tokens/`. + +!!! note + The creation and modification of API tokens can be restricted per user by an administrator. If you don't see an option to create an API token, ask an administrator to grant you access. + +Each token contains a 160-bit key represented as 40 hexadecimal characters. When creating a token, you'll typically leave the key field blank so that a random key will be automatically generated. However, NetBox allows you to specify a key in case you need to restore a previously deleted token to operation. + +By default, a token can be used for all operations available via the API. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only. + +Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index ff6ba4e50..aea825ce3 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -6,6 +6,7 @@ v2.8.4 (FUTURE) * [#4598](https://github.com/netbox-community/netbox/issues/4598) - Display error message when invalid cable length is specified * [#4604](https://github.com/netbox-community/netbox/issues/4604) - Multi-position rear ports may only be connected to other rear ports +* [#4607](https://github.com/netbox-community/netbox/issues/4607) - Missing Contextual help for API Tokens --- From cea01e037a1e9f2e6ec3006fb1b3c24119e427ab Mon Sep 17 00:00:00 2001 From: weisdd <46579601+weisdd@users.noreply.github.com> Date: Mon, 11 May 2020 16:14:25 +0300 Subject: [PATCH 09/19] Fix: incorrect DeviceConnectionsReport in reports.md (#4606) Since the CONNECTION_STATUS_PLANNED constant is gone from dcim.constants, the DeviceConnectionsReport script is no longer correct. The suggested fix is based on the fact that console_port.connection_status and power_port.connection_status currently have the following set of values: * None = A cable is not connected to a Console Server Port or it's connected to a Rear/Front Port; * False = A cable is connected to a Console Server Port and marked as Planned; * True = A cable is connected to a Console Server Port and marked as Installed. --- docs/additional-features/reports.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/additional-features/reports.md b/docs/additional-features/reports.md index 6deddc140..e845117c0 100644 --- a/docs/additional-features/reports.md +++ b/docs/additional-features/reports.md @@ -33,7 +33,6 @@ Within each report class, we'll create a number of test methods to execute our r ``` from dcim.choices import DeviceStatusChoices -from dcim.constants import CONNECTION_STATUS_PLANNED from dcim.models import ConsolePort, Device, PowerPort from extras.reports import Report @@ -51,7 +50,7 @@ class DeviceConnectionsReport(Report): console_port.device, "No console connection defined for {}".format(console_port.name) ) - elif console_port.connection_status == CONNECTION_STATUS_PLANNED: + elif not console_port.connection_status: self.log_warning( console_port.device, "Console connection for {} marked as planned".format(console_port.name) @@ -67,7 +66,7 @@ class DeviceConnectionsReport(Report): for power_port in PowerPort.objects.filter(device=device): if power_port.connected_endpoint is not None: connected_ports += 1 - if power_port.connection_status == CONNECTION_STATUS_PLANNED: + if not power_port.connection_status: self.log_warning( device, "Power connection for {} marked as planned".format(power_port.name) From 41361ce2a2cd8ace762be10d891f31572dcbec51 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Mon, 11 May 2020 16:10:23 -0500 Subject: [PATCH 10/19] Fixes: #4618 - Add group creation and correct user creation group syntax --- docs/installation/3-netbox.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index 5237e617e..c583d08fe 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -78,7 +78,8 @@ Create a system user account named `netbox`. We'll configure the WSGI and HTTP s CentOS users may need to create the `netbox` group first. ``` -# adduser --system --group netbox +# groupadd --system netbox +# adduser --system --gid netbox netbox # chown --recursive netbox /opt/netbox/netbox/media/ ``` From 1d93d9a63ad8f105d18bbac2a26dff4699fbb92f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 13 May 2020 08:53:29 -0400 Subject: [PATCH 11/19] Fixes #4633: Bump django-rq to v2.3.2 to fix ImportError with rq 1.4.0 --- docs/release-notes/version-2.8.md | 1 + requirements.txt | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index aea825ce3..416ac2bc6 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -7,6 +7,7 @@ v2.8.4 (FUTURE) * [#4598](https://github.com/netbox-community/netbox/issues/4598) - Display error message when invalid cable length is specified * [#4604](https://github.com/netbox-community/netbox/issues/4604) - Multi-position rear ports may only be connected to other rear ports * [#4607](https://github.com/netbox-community/netbox/issues/4607) - Missing Contextual help for API Tokens +* [#4633](https://github.com/netbox-community/netbox/issues/4633) - Bump django-rq to v2.3.2 to fix ImportError with rq 1.4.0 --- diff --git a/requirements.txt b/requirements.txt index c9f51cff0..79e4fdd9f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,7 +6,7 @@ django-filter==2.2.0 django-mptt==0.11.0 django-pglocks==1.0.4 django-prometheus==2.0.0 -django-rq==2.3.1 +django-rq==2.3.2 django-tables2==2.3.1 django-taggit==1.2.0 django-taggit-serializer==0.1.7 From 569d4ee201bb61d0310283014cbe7a9a3d10f04f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 13 May 2020 09:20:24 -0400 Subject: [PATCH 12/19] Closes #4632: Extend email configuration parameters to support SSL/TLS --- docs/configuration/optional-settings.md | 20 ++++++++++++-------- docs/release-notes/version-2.8.md | 4 ++++ netbox/netbox/configuration.example.py | 2 ++ netbox/netbox/settings.py | 8 ++++++-- 4 files changed, 24 insertions(+), 10 deletions(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 3f2b29b87..4d5251f25 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -108,16 +108,20 @@ The file path to NetBox's documentation. This is used when presenting context-se ## EMAIL -In order to send email, NetBox needs an email server configured. The following items can be defined within the `EMAIL` setting: +In order to send email, NetBox needs an email server configured. The following items can be defined within the `EMAIL` configuration parameter: -* SERVER - Host name or IP address of the email server (use `localhost` if running locally) -* PORT - TCP port to use for the connection (default: 25) -* USERNAME - Username with which to authenticate -* PASSSWORD - Password with which to authenticate -* TIMEOUT - Amount of time to wait for a connection (seconds) -* FROM_EMAIL - Sender address for emails sent by NetBox +* `SERVER` - Host name or IP address of the email server (use `localhost` if running locally) +* `PORT` - TCP port to use for the connection (default: `25`) +* `USERNAME` - Username with which to authenticate +* `PASSSWORD` - Password with which to authenticate +* `USE_SSL` - Use SSL when connecting to the server (default: `False`). Mutually exclusive with `USE_TLS`. +* `USE_TLS` - Use TLS when connecting to the server (default: `False`). Mutually exclusive with `USE_SSL`. +* `SSL_CERTFILE` - Path to the PEM-formatted SSL certificate file (optional) +* `SSL_KEYFILE` - Path to the PEM-formatted SSL private key file (optional) +* `TIMEOUT` - Amount of time to wait for a connection, in seconds (default: `10`) +* `FROM_EMAIL` - Sender address for emails sent by NetBox (default: `root@localhost`) -Email is sent from NetBox only for critical events. If you would like to test the email server configuration please use the django function [send_mail()](https://docs.djangoproject.com/en/stable/topics/email/#send-mail): +Email is sent from NetBox only for critical events or if configured for [logging](#logging). If you would like to test the email server configuration please use the django function [send_mail()](https://docs.djangoproject.com/en/stable/topics/email/#send-mail): ``` # python ./manage.py nbshell diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index 416ac2bc6..e15df481d 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -2,6 +2,10 @@ v2.8.4 (FUTURE) +### Enhancements + +* [#4632](https://github.com/netbox-community/netbox/issues/4632) - Extend email configuration parameters to support SSL/TLS + ### Bug Fixes * [#4598](https://github.com/netbox-community/netbox/issues/4598) - Display error message when invalid cable length is specified diff --git a/netbox/netbox/configuration.example.py b/netbox/netbox/configuration.example.py index 94497f3cd..a020c4322 100644 --- a/netbox/netbox/configuration.example.py +++ b/netbox/netbox/configuration.example.py @@ -108,6 +108,8 @@ EMAIL = { 'PORT': 25, 'USERNAME': '', 'PASSWORD': '', + 'USE_SSL': False, + 'USE_TLS': False, 'TIMEOUT': 10, # seconds 'FROM_EMAIL': '', } diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index f928ca71e..0162fabd0 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -246,12 +246,16 @@ if SESSION_FILE_PATH is not None: # EMAIL_HOST = EMAIL.get('SERVER') -EMAIL_PORT = EMAIL.get('PORT', 25) EMAIL_HOST_USER = EMAIL.get('USERNAME') EMAIL_HOST_PASSWORD = EMAIL.get('PASSWORD') +EMAIL_PORT = EMAIL.get('PORT', 25) +EMAIL_SSL_CERTFILE = EMAIL.get('SSL_CERTFILE') +EMAIL_SSL_KEYFILE = EMAIL.get('SSL_KEYFILE') +EMAIL_SUBJECT_PREFIX = '[NetBox] ' +EMAIL_USE_SSL = EMAIL.get('USE_SSL', False) +EMAIL_USE_TLS = EMAIL.get('USE_TLS', False) EMAIL_TIMEOUT = EMAIL.get('TIMEOUT', 10) SERVER_EMAIL = EMAIL.get('FROM_EMAIL') -EMAIL_SUBJECT_PREFIX = '[NetBox] ' # From 1461be20041b520b98166cf3129f94ab45acbe0f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 13 May 2020 10:28:48 -0400 Subject: [PATCH 13/19] Fixes #4613: Fix tag assignment on config contexts (regression from #4527) --- docs/release-notes/version-2.8.md | 1 + netbox/circuits/forms.py | 2 +- netbox/dcim/forms.py | 3 +-- netbox/extras/forms.py | 11 ++++++++++- netbox/ipam/forms.py | 2 +- netbox/project-static/js/forms.js | 16 ++++++++-------- netbox/secrets/forms.py | 2 +- netbox/tenancy/forms.py | 2 +- netbox/virtualization/forms.py | 2 +- 9 files changed, 25 insertions(+), 16 deletions(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index e15df481d..7cc05a9f7 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -11,6 +11,7 @@ v2.8.4 (FUTURE) * [#4598](https://github.com/netbox-community/netbox/issues/4598) - Display error message when invalid cable length is specified * [#4604](https://github.com/netbox-community/netbox/issues/4604) - Multi-position rear ports may only be connected to other rear ports * [#4607](https://github.com/netbox-community/netbox/issues/4607) - Missing Contextual help for API Tokens +* [#4613](https://github.com/netbox-community/netbox/issues/4613) - Fix tag assignment on config contexts (regression from #4527) * [#4633](https://github.com/netbox-community/netbox/issues/4633) - Bump django-rq to v2.3.2 to fix ImportError with rq 1.4.0 --- diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index 427dc2e89..2185d1eab 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -1,9 +1,9 @@ from django import forms -from taggit.forms import TagField from dcim.models import Region, Site from extras.forms import ( AddRemoveTagsForm, CustomFieldBulkEditForm, CustomFieldFilterForm, CustomFieldModelForm, CustomFieldModelCSVForm, + TagField, ) from tenancy.forms import TenancyFilterForm, TenancyForm from tenancy.models import Tenant diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 2116d0948..5d3ec1019 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -9,13 +9,12 @@ from django.utils.safestring import mark_safe from mptt.forms import TreeNodeChoiceField from netaddr import EUI from netaddr.core import AddrFormatError -from taggit.forms import TagField from timezone_field import TimeZoneFormField from circuits.models import Circuit, Provider from extras.forms import ( AddRemoveTagsForm, CustomFieldBulkEditForm, CustomFieldModelCSVForm, CustomFieldFilterForm, CustomFieldModelForm, - LocalConfigContextFilterForm, + LocalConfigContextFilterForm, TagField, ) from ipam.constants import BGP_ASN_MAX, BGP_ASN_MIN from ipam.models import IPAddress, VLAN diff --git a/netbox/extras/forms.py b/netbox/extras/forms.py index 384b3563b..469b55efd 100644 --- a/netbox/extras/forms.py +++ b/netbox/extras/forms.py @@ -2,7 +2,7 @@ from django import forms from django.contrib.auth.models import User from django.contrib.contenttypes.models import ContentType from mptt.forms import TreeNodeMultipleChoiceField -from taggit.forms import TagField +from taggit.forms import TagField as TagField_ from dcim.models import DeviceRole, Platform, Region, Site from tenancy.models import Tenant, TenantGroup @@ -142,6 +142,15 @@ class CustomFieldFilterForm(forms.Form): # Tags # +class TagField(TagField_): + + def widget_attrs(self, widget): + # Apply the "tagfield" CSS class to trigger the special API-based selection widget for tags + return { + 'class': 'tagfield' + } + + class TagForm(BootstrapMixin, forms.ModelForm): slug = SlugField() diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index 4e5a413dc..f5fd6e5f8 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -1,10 +1,10 @@ from django import forms from django.core.validators import MaxValueValidator, MinValueValidator -from taggit.forms import TagField from dcim.models import Device, Interface, Rack, Region, Site from extras.forms import ( AddRemoveTagsForm, CustomFieldBulkEditForm, CustomFieldModelCSVForm, CustomFieldModelForm, CustomFieldFilterForm, + TagField, ) from tenancy.forms import TenancyFilterForm, TenancyForm from tenancy.models import Tenant diff --git a/netbox/project-static/js/forms.js b/netbox/project-static/js/forms.js index 06d4a742a..b97981f0e 100644 --- a/netbox/project-static/js/forms.js +++ b/netbox/project-static/js/forms.js @@ -292,9 +292,9 @@ $(document).ready(function() { }); // API backed tags - var tags = $('#id_tags'); + var tags = $('#id_tags.tagfield'); if (tags.length > 0 && tags.val().length > 0){ - tags = $('#id_tags').val().split(/,\s*/); + tags = $('#id_tags.tagfield').val().split(/,\s*/); } else { tags = []; } @@ -306,8 +306,8 @@ $(document).ready(function() { } }); // Replace the django issued text input with a select element - $('#id_tags').replaceWith(''); - $('#id_tags').select2({ + $('#id_tags.tagfield').replaceWith(''); + $('#id_tags.tagfield').select2({ tags: true, data: tag_objs, multiple: true, @@ -354,14 +354,14 @@ $(document).ready(function() { } } }); - $('#id_tags').closest('form').submit(function(event){ + $('#id_tags.tagfield').closest('form').submit(function(event){ // django-taggit can only accept a single comma seperated string value - var value = $('#id_tags').val(); + var value = $('#id_tags.tagfield').val(); if (value.length > 0){ var final_tags = value.join(', '); - $('#id_tags').val(null).trigger('change'); + $('#id_tags.tagfield').val(null).trigger('change'); var option = new Option(final_tags, final_tags, true, true); - $('#id_tags').append(option).trigger('change'); + $('#id_tags.tagfield').append(option).trigger('change'); } }); diff --git a/netbox/secrets/forms.py b/netbox/secrets/forms.py index 368a47590..089771bd8 100644 --- a/netbox/secrets/forms.py +++ b/netbox/secrets/forms.py @@ -1,11 +1,11 @@ from Crypto.Cipher import PKCS1_OAEP from Crypto.PublicKey import RSA from django import forms -from taggit.forms import TagField from dcim.models import Device from extras.forms import ( AddRemoveTagsForm, CustomFieldBulkEditForm, CustomFieldFilterForm, CustomFieldModelForm, CustomFieldModelCSVForm, + TagField, ) from utilities.forms import ( APISelectMultiple, BootstrapMixin, CSVModelChoiceField, CSVModelForm, DynamicModelChoiceField, diff --git a/netbox/tenancy/forms.py b/netbox/tenancy/forms.py index 700d88b1d..bf100f43a 100644 --- a/netbox/tenancy/forms.py +++ b/netbox/tenancy/forms.py @@ -1,8 +1,8 @@ from django import forms -from taggit.forms import TagField from extras.forms import ( AddRemoveTagsForm, CustomFieldModelForm, CustomFieldBulkEditForm, CustomFieldFilterForm, CustomFieldModelCSVForm, + TagField, ) from utilities.forms import ( APISelect, APISelectMultiple, BootstrapMixin, CommentField, CSVModelChoiceField, CSVModelForm, diff --git a/netbox/virtualization/forms.py b/netbox/virtualization/forms.py index 0983b2432..2f2ee4950 100644 --- a/netbox/virtualization/forms.py +++ b/netbox/virtualization/forms.py @@ -1,6 +1,5 @@ from django import forms from django.core.exceptions import ValidationError -from taggit.forms import TagField from dcim.choices import InterfaceModeChoices from dcim.constants import INTERFACE_MTU_MAX, INTERFACE_MTU_MIN @@ -8,6 +7,7 @@ from dcim.forms import INTERFACE_MODE_HELP_TEXT from dcim.models import Device, DeviceRole, Interface, Platform, Rack, Region, Site from extras.forms import ( AddRemoveTagsForm, CustomFieldBulkEditForm, CustomFieldModelCSVForm, CustomFieldModelForm, CustomFieldFilterForm, + TagField, ) from ipam.models import IPAddress, VLAN from tenancy.forms import TenancyFilterForm, TenancyForm From fd0be35d99df6376736f5ced1a08984be4519f87 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 13 May 2020 09:26:56 -0500 Subject: [PATCH 14/19] #4634 - Correct inventory item table accessor definition on manufacturer column --- docs/release-notes/version-2.8.md | 1 + netbox/dcim/tables.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index e15df481d..a3249915b 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -12,6 +12,7 @@ v2.8.4 (FUTURE) * [#4604](https://github.com/netbox-community/netbox/issues/4604) - Multi-position rear ports may only be connected to other rear ports * [#4607](https://github.com/netbox-community/netbox/issues/4607) - Missing Contextual help for API Tokens * [#4633](https://github.com/netbox-community/netbox/issues/4633) - Bump django-rq to v2.3.2 to fix ImportError with rq 1.4.0 +* [#4634](https://github.com/netbox-community/netbox/issues/4634) - Inventory Item List view exception caused by incorrect accessor definition --- diff --git a/netbox/dcim/tables.py b/netbox/dcim/tables.py index 3fef86394..9018625a0 100644 --- a/netbox/dcim/tables.py +++ b/netbox/dcim/tables.py @@ -1195,7 +1195,7 @@ class InventoryItemTable(BaseTable): args=[Accessor('device.pk')] ) manufacturer = tables.Column( - accessor=Accessor('manufacturer.name') + accessor=Accessor('manufacturer') ) discovered = BooleanColumn() From 07fd92cd4c97b3535cf30cb7314737ad50bb0d24 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 13 May 2020 16:25:22 -0400 Subject: [PATCH 15/19] Fixes #4629: Replicate assigned interface when cloning IP addresses --- docs/release-notes/version-2.8.md | 1 + netbox/ipam/models.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index 2c8ac7927..914f17cf7 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -12,6 +12,7 @@ v2.8.4 (FUTURE) * [#4604](https://github.com/netbox-community/netbox/issues/4604) - Multi-position rear ports may only be connected to other rear ports * [#4607](https://github.com/netbox-community/netbox/issues/4607) - Missing Contextual help for API Tokens * [#4613](https://github.com/netbox-community/netbox/issues/4613) - Fix tag assignment on config contexts (regression from #4527) +* [#4629](https://github.com/netbox-community/netbox/issues/4629) - Replicate assigned interface when cloning IP addresses * [#4633](https://github.com/netbox-community/netbox/issues/4633) - Bump django-rq to v2.3.2 to fix ImportError with rq 1.4.0 * [#4634](https://github.com/netbox-community/netbox/issues/4634) - Inventory Item List view exception caused by incorrect accessor definition diff --git a/netbox/ipam/models.py b/netbox/ipam/models.py index 84720845e..eeb985b7c 100644 --- a/netbox/ipam/models.py +++ b/netbox/ipam/models.py @@ -640,7 +640,7 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): 'dns_name', 'description', ] clone_fields = [ - 'vrf', 'tenant', 'status', 'role', 'description', + 'vrf', 'tenant', 'status', 'role', 'description', 'interface', ] STATUS_CLASS_MAP = { From 96e05fb12d73badfd32865de3cd8f6542352df26 Mon Sep 17 00:00:00 2001 From: Tyler Bigler Date: Mon, 11 May 2020 11:18:20 -0400 Subject: [PATCH 16/19] Notes on multiprocessing and gunicorn vs uwsgi --- docs/additional-features/prometheus-metrics.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/additional-features/prometheus-metrics.md b/docs/additional-features/prometheus-metrics.md index 0aa944b74..448f925e0 100644 --- a/docs/additional-features/prometheus-metrics.md +++ b/docs/additional-features/prometheus-metrics.md @@ -32,3 +32,7 @@ This can be setup by first creating a shared directory and then adding this line ``` environment=prometheus_multiproc_dir=/tmp/prometheus_metrics ``` + +#### Accuracy + +If having long-term-accurate metrics in a multiprocess environment is important to you then it's recommended you use the `uwsgi` library instead of `gunicorn`. The issue lies in the way `gunicorn` tracks worker processes (vs `uwsgi`) which helps manage the metrics files created by the above configurations. If you're using Netbox w/ `gunicorn` in a containerized enviroment following the 1-process-per-container methodology, then you will likely not need to change to `uwsgi`. More details can be found in [this issue](https://github.com/netbox-community/netbox/issues/3779#issuecomment-590547562). \ No newline at end of file From e0ebb8e7d894ab57594f37baceb9ee1b6624927a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 13 May 2020 17:08:48 -0400 Subject: [PATCH 17/19] Fixes #4617: Restore IP prefix depth notation in list view --- docs/release-notes/version-2.8.md | 1 + netbox/ipam/tables.py | 2 ++ netbox/utilities/tables.py | 9 +++++++-- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index 914f17cf7..17e04dad3 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -12,6 +12,7 @@ v2.8.4 (FUTURE) * [#4604](https://github.com/netbox-community/netbox/issues/4604) - Multi-position rear ports may only be connected to other rear ports * [#4607](https://github.com/netbox-community/netbox/issues/4607) - Missing Contextual help for API Tokens * [#4613](https://github.com/netbox-community/netbox/issues/4613) - Fix tag assignment on config contexts (regression from #4527) +* [#4617](https://github.com/netbox-community/netbox/issues/4617) - Restore IP prefix depth notation in list view * [#4629](https://github.com/netbox-community/netbox/issues/4629) - Replicate assigned interface when cloning IP addresses * [#4633](https://github.com/netbox-community/netbox/issues/4633) - Bump django-rq to v2.3.2 to fix ImportError with rq 1.4.0 * [#4634](https://github.com/netbox-community/netbox/issues/4634) - Inventory Item List view exception caused by incorrect accessor definition diff --git a/netbox/ipam/tables.py b/netbox/ipam/tables.py index 23bf14653..d8b50c11d 100644 --- a/netbox/ipam/tables.py +++ b/netbox/ipam/tables.py @@ -378,6 +378,8 @@ class PrefixTable(BaseTable): verbose_name='Pool' ) + add_prefetch = False + class Meta(BaseTable.Meta): model = Prefix fields = ('pk', 'prefix', 'status', 'vrf', 'tenant', 'site', 'vlan', 'role', 'is_pool', 'description') diff --git a/netbox/utilities/tables.py b/netbox/utilities/tables.py index 0702936b5..97108b5b2 100644 --- a/netbox/utilities/tables.py +++ b/netbox/utilities/tables.py @@ -1,6 +1,5 @@ import django_tables2 as tables from django.core.exceptions import FieldDoesNotExist -from django.db.models import ForeignKey from django.db.models.fields.related import RelatedField from django.utils.safestring import mark_safe from django_tables2.data import TableQuerysetData @@ -9,7 +8,13 @@ from django_tables2.data import TableQuerysetData class BaseTable(tables.Table): """ Default table for object lists + + :param add_prefetch: By default, modify the queryset passed to the table upon initialization to automatically + prefetch related data. Set this to False if it's necessary to avoid modifying the queryset (e.g. to + accommodate PrefixQuerySet.annotate_depth()). """ + add_prefetch = True + class Meta: attrs = { 'class': 'table table-hover table-headings', @@ -50,7 +55,7 @@ class BaseTable(tables.Table): self.sequence.append('actions') # Dynamically update the table's QuerySet to ensure related fields are pre-fetched - if isinstance(self.data, TableQuerysetData): + if self.add_prefetch and isinstance(self.data, TableQuerysetData): model = getattr(self.Meta, 'model') prefetch_fields = [] for column in self.columns: From 29abcbced8780fab47e8cd85c50e2b012953e0aa Mon Sep 17 00:00:00 2001 From: Tyler Bigler Date: Wed, 13 May 2020 17:13:41 -0400 Subject: [PATCH 18/19] Grammar improvements --- docs/additional-features/prometheus-metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/additional-features/prometheus-metrics.md b/docs/additional-features/prometheus-metrics.md index 448f925e0..1429fb0a7 100644 --- a/docs/additional-features/prometheus-metrics.md +++ b/docs/additional-features/prometheus-metrics.md @@ -35,4 +35,4 @@ environment=prometheus_multiproc_dir=/tmp/prometheus_metrics #### Accuracy -If having long-term-accurate metrics in a multiprocess environment is important to you then it's recommended you use the `uwsgi` library instead of `gunicorn`. The issue lies in the way `gunicorn` tracks worker processes (vs `uwsgi`) which helps manage the metrics files created by the above configurations. If you're using Netbox w/ `gunicorn` in a containerized enviroment following the 1-process-per-container methodology, then you will likely not need to change to `uwsgi`. More details can be found in [this issue](https://github.com/netbox-community/netbox/issues/3779#issuecomment-590547562). \ No newline at end of file +If having accurate long-term metrics in a multiprocess environment is important to you then it's recommended you use the `uwsgi` library instead of `gunicorn`. The issue lies in the way `gunicorn` tracks worker processes (vs `uwsgi`) which helps manage the metrics files created by the above configurations. If you're using Netbox with gunicorn in a containerized enviroment following the one-process-per-container methodology, then you will likely not need to change to `uwsgi`. More details can be found in [issue #3779](https://github.com/netbox-community/netbox/issues/3779#issuecomment-590547562). \ No newline at end of file From 2900013118021b48010e6b05595ee85a7f106f3c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 13 May 2020 17:24:25 -0400 Subject: [PATCH 19/19] Release v2.8.4 --- docs/release-notes/version-2.8.md | 2 +- netbox/netbox/settings.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.8.md b/docs/release-notes/version-2.8.md index 17e04dad3..5d8687588 100644 --- a/docs/release-notes/version-2.8.md +++ b/docs/release-notes/version-2.8.md @@ -1,6 +1,6 @@ # NetBox v2.8 -v2.8.4 (FUTURE) +v2.8.4 (2020-05-13) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 0162fabd0..f06a27980 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.8.4-dev' +VERSION = '2.8.4' # Hostname HOSTNAME = platform.node()