diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 9ed740fff..51c0a5a0d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -14,7 +14,7 @@ body: attributes: label: NetBox version description: What version of NetBox are you currently running? - placeholder: v3.4.4 + placeholder: v3.4.6 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 8e4ab54a5..7c6b4e151 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -14,7 +14,7 @@ body: attributes: label: NetBox version description: What version of NetBox are you currently running? - placeholder: v3.4.4 + placeholder: v3.4.6 validations: required: true - type: dropdown diff --git a/README.md b/README.md index 053aa8461..e3c9611c0 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ NetBox provides the ideal "source of truth" to power network automation. Available as open source software under the Apache 2.0 license, NetBox serves as the cornerstone for network automation in thousands of organizations. -* **Physical infrasucture:** Accurately model the physical world, from global regions down to individual racks of gear. Then connect everything - network, console, and power! +* **Physical infrastructure:** Accurately model the physical world, from global regions down to individual racks of gear. Then connect everything - network, console, and power! * **Modern IPAM:** All the standard IPAM functionality you expect, plus VRF import/export tracking, VLAN management, and overlay support. -* **Data circuits:** Confidently manage the delivery of crtical circuits from various service providers, modeled seamlessly alongside your own infrastructure. +* **Data circuits:** Confidently manage the delivery of critical circuits from various service providers, modeled seamlessly alongside your own infrastructure. * **Power tracking:** Map the distribution of power from upstream sources to individual feeds and outlets. * **Organization:** Manage tenant and contact assignments natively. * **Powerful search:** Easily find anything you need using a single global search function. diff --git a/contrib/apache.conf b/contrib/apache.conf index 1804e380d..73fd45c26 100644 --- a/contrib/apache.conf +++ b/contrib/apache.conf @@ -1,3 +1,12 @@ + + # CHANGE THIS TO YOUR SERVER'S NAME + ServerName netbox.example.com + + RewriteEngine On + RewriteCond %{HTTPS} !=on + RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [R,L] + + ProxyPreserveHost On diff --git a/docs/configuration/miscellaneous.md b/docs/configuration/miscellaneous.md index eac5d0a2f..8550564d8 100644 --- a/docs/configuration/miscellaneous.md +++ b/docs/configuration/miscellaneous.md @@ -69,11 +69,11 @@ By default, NetBox will permit users to create duplicate prefixes and IP address --- -## FILE_UPLOAD_MAX_MEMORY_SIZE +## `FILE_UPLOAD_MAX_MEMORY_SIZE` -Default: 2621440 (i.e. 2.5 MB). +Default: `2621440` (2.5 MB). -The maximum size (in bytes) that an upload will be before it gets streamed to the file system. Changing this setting can be useful for example to be able to upload files bigger than 2.5MB to custom scripts for processing. +The maximum amount (in bytes) of uploaded data that will be held in memory before being written to the filesystem. Changing this setting can be useful for example to be able to upload files bigger than 2.5MB to custom scripts for processing. --- diff --git a/docs/installation/5-http-server.md b/docs/installation/5-http-server.md index 907964554..b81c6d84a 100644 --- a/docs/installation/5-http-server.md +++ b/docs/installation/5-http-server.md @@ -65,7 +65,7 @@ sudo cp /opt/netbox/contrib/apache.conf /etc/apache2/sites-available/netbox.conf Finally, ensure that the required Apache modules are enabled, enable the `netbox` site, and reload Apache: ```no-highlight -sudo a2enmod ssl proxy proxy_http headers +sudo a2enmod ssl proxy proxy_http headers rewrite sudo a2ensite netbox sudo systemctl restart apache2 ``` diff --git a/docs/release-notes/version-3.4.md b/docs/release-notes/version-3.4.md index 485b85719..43f4dab5e 100644 --- a/docs/release-notes/version-3.4.md +++ b/docs/release-notes/version-3.4.md @@ -1,18 +1,46 @@ # NetBox v3.4 -## v3.4.5 (FUTURE) +## v3.4.6 (2023-03-13) + +### Enhancements + +* [#10058](https://github.com/netbox-community/netbox/issues/10058) - Enable searching for devices/VMs by primary IP address +* [#11011](https://github.com/netbox-community/netbox/issues/11011) - Add ability to toggle visibility of virtual interfaces under device view +* [#11294](https://github.com/netbox-community/netbox/issues/11294) - Enable live preview of Markdown content +* [#11807](https://github.com/netbox-community/netbox/issues/11807) - Restore default page size when navigating between views +* [#11817](https://github.com/netbox-community/netbox/issues/11817) - Add `connected_endpoints` field to GraphQL API for cabled objects +* [#11851](https://github.com/netbox-community/netbox/issues/11851) - Include IP version in GraphQL API representations of aggregates, prefixes, and IP addresses +* [#11862](https://github.com/netbox-community/netbox/issues/11862) - Add Cisco StackWise 1T interface type +* [#11871](https://github.com/netbox-community/netbox/issues/11871) - Add IEEE 802.3az PoE type for interfaces +* [#11929](https://github.com/netbox-community/netbox/issues/11929) - Strip whitespace from CSV headers prior to validation + +### Bug Fixes + +* [#11470](https://github.com/netbox-community/netbox/issues/11470) - Avoid raising exception when filtering IPs by an invalid address +* [#11565](https://github.com/netbox-community/netbox/issues/11565) - Apply custom field defaults to IP address created during FHRP group creation +* [#11631](https://github.com/netbox-community/netbox/issues/11631) - Fix filtering changelog & journal entries by multiple content type IDs +* [#11758](https://github.com/netbox-community/netbox/issues/11758) - Support non-URL-safe characters in plugin menu titles +* [#11796](https://github.com/netbox-community/netbox/issues/11796) - When importing devices, restrict rack by location only if the location field is specified +* [#11819](https://github.com/netbox-community/netbox/issues/11819) - Fix filtering of cable terminations by object type +* [#11850](https://github.com/netbox-community/netbox/issues/11850) - Fix loading of CSV files containing a byte order mark +* [#11903](https://github.com/netbox-community/netbox/issues/11903) - Fix escaping of return URL values for action buttons in tables +* [#11927](https://github.com/netbox-community/netbox/issues/11927) - Correct loading of plugin resources with custom paths + +--- + +## v3.4.5 (2023-02-21) ### Enhancements * [#11110](https://github.com/netbox-community/netbox/issues/11110) - Add `start_address` and `end_address` filters for IP ranges * [#11592](https://github.com/netbox-community/netbox/issues/11592) - Introduce `FILE_UPLOAD_MAX_MEMORY_SIZE` configuration parameter * [#11685](https://github.com/netbox-community/netbox/issues/11685) - Match on containing prefixes and aggregates when querying for IP addresses using global search +* [#11787](https://github.com/netbox-community/netbox/issues/11787) - Upgrade script will automatically rebuild missing search cache ### Bug Fixes * [#11032](https://github.com/netbox-community/netbox/issues/11032) - Fix false custom validation errors during component creation * [#11226](https://github.com/netbox-community/netbox/issues/11226) - Ensure scripts and reports within submodules are automatically reloaded -* [#11335](https://github.com/netbox-community/netbox/issues/11335) - Avoid exception when rendering change log after uninstalling a plugin * [#11459](https://github.com/netbox-community/netbox/issues/11459) - Enable evaluating null values in custom validation rules * [#11473](https://github.com/netbox-community/netbox/issues/11473) - GraphQL requests specifying an invalid filter should return an empty queryset * [#11582](https://github.com/netbox-community/netbox/issues/11582) - Ensure form validation errors are displayed when adding virtual chassis members @@ -20,6 +48,7 @@ * [#11683](https://github.com/netbox-community/netbox/issues/11683) - Fix CSV header attribute detection when auto-detecting import format * [#11711](https://github.com/netbox-community/netbox/issues/11711) - Fix CSV import for multiple-object custom fields * [#11723](https://github.com/netbox-community/netbox/issues/11723) - Circuit terminations should link to their associated circuits (rather than site or provider network) +* [#11775](https://github.com/netbox-community/netbox/issues/11775) - Skip checking for old search cache records when creating a new object * [#11786](https://github.com/netbox-community/netbox/issues/11786) - List only applicable object types in form widget when filtering custom fields --- diff --git a/netbox/circuits/forms/bulk_edit.py b/netbox/circuits/forms/bulk_edit.py index a3e91c8ae..8fd09d3ee 100644 --- a/netbox/circuits/forms/bulk_edit.py +++ b/netbox/circuits/forms/bulk_edit.py @@ -34,7 +34,6 @@ class ProviderBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label=_('Comments') ) @@ -62,7 +61,6 @@ class ProviderNetworkBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label=_('Comments') ) @@ -123,7 +121,6 @@ class CircuitBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label=_('Comments') ) diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index f1485b67f..c495c42ec 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -902,6 +902,7 @@ class InterfaceTypeChoices(ChoiceSet): TYPE_STACKWISE160 = 'cisco-stackwise-160' TYPE_STACKWISE320 = 'cisco-stackwise-320' TYPE_STACKWISE480 = 'cisco-stackwise-480' + TYPE_STACKWISE1T = 'cisco-stackwise-1t' TYPE_JUNIPER_VCP = 'juniper-vcp' TYPE_SUMMITSTACK = 'extreme-summitstack' TYPE_SUMMITSTACK128 = 'extreme-summitstack-128' @@ -1078,6 +1079,7 @@ class InterfaceTypeChoices(ChoiceSet): (TYPE_STACKWISE160, 'Cisco StackWise-160'), (TYPE_STACKWISE320, 'Cisco StackWise-320'), (TYPE_STACKWISE480, 'Cisco StackWise-480'), + (TYPE_STACKWISE1T, 'Cisco StackWise-1T'), (TYPE_JUNIPER_VCP, 'Juniper VCP'), (TYPE_SUMMITSTACK, 'Extreme SummitStack'), (TYPE_SUMMITSTACK128, 'Extreme SummitStack-128'), @@ -1135,6 +1137,7 @@ class InterfacePoETypeChoices(ChoiceSet): TYPE_1_8023AF = 'type1-ieee802.3af' TYPE_2_8023AT = 'type2-ieee802.3at' + TYPE_2_8023AZ = 'type2-ieee802.3az' TYPE_3_8023BT = 'type3-ieee802.3bt' TYPE_4_8023BT = 'type4-ieee802.3bt' @@ -1149,6 +1152,7 @@ class InterfacePoETypeChoices(ChoiceSet): ( (TYPE_1_8023AF, '802.3af (Type 1)'), (TYPE_2_8023AT, '802.3at (Type 2)'), + (TYPE_2_8023AZ, '802.3az (Type 2)'), (TYPE_3_8023BT, '802.3bt (Type 3)'), (TYPE_4_8023BT, '802.3bt (Type 4)'), ) diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 7a27ef110..4b9ed583f 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1004,7 +1004,9 @@ class DeviceFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilter Q(serial__icontains=value.strip()) | Q(inventoryitems__serial__icontains=value.strip()) | Q(asset_tag__icontains=value.strip()) | - Q(comments__icontains=value) + Q(comments__icontains=value) | + Q(primary_ip4__address__startswith=value) | + Q(primary_ip6__address__startswith=value) ).distinct() def _has_primary_ip(self, queryset, name, value): @@ -1748,6 +1750,7 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): class CableTerminationFilterSet(BaseFilterSet): + termination_type = ContentTypeFilter() class Meta: model = CableTermination diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index 5b605dbb4..ffbf8e10e 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -137,7 +137,6 @@ class SiteBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -302,7 +301,6 @@ class RackBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -337,7 +335,6 @@ class RackReservationBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -400,7 +397,6 @@ class DeviceTypeBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -434,7 +430,6 @@ class ModuleTypeBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -549,7 +544,6 @@ class DeviceBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -592,7 +586,6 @@ class ModuleBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -639,7 +632,6 @@ class CableBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -663,7 +655,6 @@ class VirtualChassisBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -709,7 +700,6 @@ class PowerPanelBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -767,7 +757,6 @@ class PowerFeedBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label=_('Comments') ) diff --git a/netbox/dcim/forms/bulk_import.py b/netbox/dcim/forms/bulk_import.py index 929f44762..d6e898b41 100644 --- a/netbox/dcim/forms/bulk_import.py +++ b/netbox/dcim/forms/bulk_import.py @@ -469,11 +469,14 @@ class DeviceImportForm(BaseDeviceImportForm): self.fields['location'].queryset = self.fields['location'].queryset.filter(**params) self.fields['parent'].queryset = self.fields['parent'].queryset.filter(**params) - # Limit rack queryset by assigned site and group + # Limit rack queryset by assigned site and location params = { f"site__{self.fields['site'].to_field_name}": data.get('site'), - f"location__{self.fields['location'].to_field_name}": data.get('location'), } + if 'location' in data: + params.update({ + f"location__{self.fields['location'].to_field_name}": data.get('location'), + }) self.fields['rack'].queryset = self.fields['rack'].queryset.filter(**params) # Limit device bay queryset by parent device diff --git a/netbox/dcim/graphql/mixins.py b/netbox/dcim/graphql/mixins.py index 133d6259f..f8e626fe8 100644 --- a/netbox/dcim/graphql/mixins.py +++ b/netbox/dcim/graphql/mixins.py @@ -10,3 +10,11 @@ class CabledObjectMixin: def resolve_link_peers(self, info): return self.link_peers + + +class PathEndpointMixin: + connected_endpoints = graphene.List('dcim.graphql.gfk_mixins.LinkPeerType') + + def resolve_connected_endpoints(self, info): + # Handle empty values + return self.connected_endpoints or None diff --git a/netbox/dcim/graphql/types.py b/netbox/dcim/graphql/types.py index 41f0092f9..3c6c0a885 100644 --- a/netbox/dcim/graphql/types.py +++ b/netbox/dcim/graphql/types.py @@ -7,7 +7,7 @@ from extras.graphql.mixins import ( from ipam.graphql.mixins import IPAddressesMixin, VLANGroupsMixin from netbox.graphql.scalars import BigInt from netbox.graphql.types import BaseObjectType, OrganizationalObjectType, NetBoxObjectType -from .mixins import CabledObjectMixin +from .mixins import CabledObjectMixin, PathEndpointMixin __all__ = ( 'CableType', @@ -117,7 +117,7 @@ class CableTerminationType(NetBoxObjectType): filterset_class = filtersets.CableTerminationFilterSet -class ConsolePortType(ComponentObjectType, CabledObjectMixin): +class ConsolePortType(ComponentObjectType, CabledObjectMixin, PathEndpointMixin): class Meta: model = models.ConsolePort @@ -139,7 +139,7 @@ class ConsolePortTemplateType(ComponentTemplateObjectType): return self.type or None -class ConsoleServerPortType(ComponentObjectType, CabledObjectMixin): +class ConsoleServerPortType(ComponentObjectType, CabledObjectMixin, PathEndpointMixin): class Meta: model = models.ConsoleServerPort @@ -241,7 +241,7 @@ class FrontPortTemplateType(ComponentTemplateObjectType): filterset_class = filtersets.FrontPortTemplateFilterSet -class InterfaceType(IPAddressesMixin, ComponentObjectType, CabledObjectMixin): +class InterfaceType(IPAddressesMixin, ComponentObjectType, CabledObjectMixin, PathEndpointMixin): class Meta: model = models.Interface @@ -354,7 +354,7 @@ class PlatformType(OrganizationalObjectType): filterset_class = filtersets.PlatformFilterSet -class PowerFeedType(NetBoxObjectType, CabledObjectMixin): +class PowerFeedType(NetBoxObjectType, CabledObjectMixin, PathEndpointMixin): class Meta: model = models.PowerFeed @@ -362,7 +362,7 @@ class PowerFeedType(NetBoxObjectType, CabledObjectMixin): filterset_class = filtersets.PowerFeedFilterSet -class PowerOutletType(ComponentObjectType, CabledObjectMixin): +class PowerOutletType(ComponentObjectType, CabledObjectMixin, PathEndpointMixin): class Meta: model = models.PowerOutlet @@ -398,7 +398,7 @@ class PowerPanelType(NetBoxObjectType, ContactsMixin): filterset_class = filtersets.PowerPanelFilterSet -class PowerPortType(ComponentObjectType, CabledObjectMixin): +class PowerPortType(ComponentObjectType, CabledObjectMixin, PathEndpointMixin): class Meta: model = models.PowerPort diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index bed32251c..8ce19bcde 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -600,6 +600,7 @@ class DeviceInterfaceTable(InterfaceTable): 'class': get_interface_row_class, 'data-name': lambda record: record.name, 'data-enabled': get_interface_state_attribute, + 'data-type': lambda record: record.type, } diff --git a/netbox/extras/filtersets.py b/netbox/extras/filtersets.py index 4d9947147..53898a0c9 100644 --- a/netbox/extras/filtersets.py +++ b/netbox/extras/filtersets.py @@ -220,6 +220,9 @@ class ImageAttachmentFilterSet(BaseFilterSet): class JournalEntryFilterSet(NetBoxModelFilterSet): created = django_filters.DateTimeFromToRangeFilter() assigned_object_type = ContentTypeFilter() + assigned_object_type_id = django_filters.ModelMultipleChoiceFilter( + queryset=ContentType.objects.all() + ) created_by_id = django_filters.ModelMultipleChoiceFilter( queryset=User.objects.all(), label=_('User (ID)'), @@ -504,6 +507,9 @@ class ObjectChangeFilterSet(BaseFilterSet): ) time = django_filters.DateTimeFromToRangeFilter() changed_object_type = ContentTypeFilter() + changed_object_type_id = django_filters.ModelMultipleChoiceFilter( + queryset=ContentType.objects.all() + ) user_id = django_filters.ModelMultipleChoiceFilter( queryset=User.objects.all(), label=_('User (ID)'), diff --git a/netbox/extras/forms/__init__.py b/netbox/extras/forms/__init__.py index af0f7cf43..0825c9ca7 100644 --- a/netbox/extras/forms/__init__.py +++ b/netbox/extras/forms/__init__.py @@ -2,6 +2,7 @@ from .model_forms import * from .filtersets import * from .bulk_edit import * from .bulk_import import * +from .misc import * from .mixins import * from .config import * from .scripts import * diff --git a/netbox/extras/forms/misc.py b/netbox/extras/forms/misc.py new file mode 100644 index 000000000..b52338e76 --- /dev/null +++ b/netbox/extras/forms/misc.py @@ -0,0 +1,14 @@ +from django import forms + +__all__ = ( + 'RenderMarkdownForm', +) + + +class RenderMarkdownForm(forms.Form): + """ + Provides basic validation for markup to be rendered. + """ + text = forms.CharField( + required=False + ) diff --git a/netbox/extras/management/commands/reindex.py b/netbox/extras/management/commands/reindex.py index b601a1ac1..9a29c54f5 100644 --- a/netbox/extras/management/commands/reindex.py +++ b/netbox/extras/management/commands/reindex.py @@ -15,6 +15,11 @@ class Command(BaseCommand): nargs='*', help='One or more apps or models to reindex', ) + parser.add_argument( + '--lazy', + action='store_true', + help="For each model, reindex objects only if no cache entries already exist" + ) def _get_indexers(self, *model_names): indexers = {} @@ -60,14 +65,15 @@ class Command(BaseCommand): raise CommandError("No indexers found!") self.stdout.write(f'Reindexing {len(indexers)} models.') - # Clear all cached values for the specified models - self.stdout.write('Clearing cached values... ', ending='') - self.stdout.flush() - content_types = [ - ContentType.objects.get_for_model(model) for model in indexers.keys() - ] - deleted_count = search_backend.clear(content_types) - self.stdout.write(f'{deleted_count} entries deleted.') + # Clear all cached values for the specified models (if not being lazy) + if not kwargs['lazy']: + self.stdout.write('Clearing cached values... ', ending='') + self.stdout.flush() + content_types = [ + ContentType.objects.get_for_model(model) for model in indexers.keys() + ] + deleted_count = search_backend.clear(content_types) + self.stdout.write(f'{deleted_count} entries deleted.') # Index models self.stdout.write('Indexing models') @@ -76,11 +82,18 @@ class Command(BaseCommand): model_name = model._meta.model_name self.stdout.write(f' {app_label}.{model_name}... ', ending='') self.stdout.flush() + + if kwargs['lazy']: + content_type = ContentType.objects.get_for_model(model) + if cached_count := search_backend.count(object_types=[content_type]): + self.stdout.write(f'Skipping (found {cached_count} existing).') + continue + i = search_backend.cache(model.objects.iterator(), remove_existing=False) if i: self.stdout.write(f'{i} entries cached.') else: - self.stdout.write(f'None found.') + self.stdout.write(f'No objects found.') msg = f'Completed.' if total_count := search_backend.size: diff --git a/netbox/extras/plugins/__init__.py b/netbox/extras/plugins/__init__.py index ee74ad88e..83c7a7bb0 100644 --- a/netbox/extras/plugins/__init__.py +++ b/netbox/extras/plugins/__init__.py @@ -78,8 +78,8 @@ class PluginConfig(AppConfig): def _load_resource(self, name): # Import from the configured path, if defined. - if getattr(self, name): - return import_string(f"{self.__module__}.{self.name}") + if path := getattr(self, name, None): + return import_string(f"{self.__module__}.{path}") # Fall back to the resource's default path. Return None if the module has not been provided. default_path = f'{self.__module__}.{DEFAULT_RESOURCE_PATHS[name]}' diff --git a/netbox/extras/plugins/navigation.py b/netbox/extras/plugins/navigation.py index e667965b8..288a78512 100644 --- a/netbox/extras/plugins/navigation.py +++ b/netbox/extras/plugins/navigation.py @@ -1,5 +1,6 @@ from netbox.navigation import MenuGroup from utilities.choices import ButtonColorChoices +from django.utils.text import slugify __all__ = ( 'PluginMenu', @@ -21,7 +22,7 @@ class PluginMenu: @property def name(self): - return self.label.replace(' ', '_') + return slugify(self.label) class PluginMenuItem: diff --git a/netbox/extras/tests/test_filtersets.py b/netbox/extras/tests/test_filtersets.py index 0c161cfae..f95cf08de 100644 --- a/netbox/extras/tests/test_filtersets.py +++ b/netbox/extras/tests/test_filtersets.py @@ -548,7 +548,7 @@ class JournalEntryTestCase(TestCase, ChangeLoggedFilterSetTests): def test_assigned_object_type(self): params = {'assigned_object_type': 'dcim.site'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) - params = {'assigned_object_type_id': ContentType.objects.get(app_label='dcim', model='site').pk} + params = {'assigned_object_type_id': [ContentType.objects.get(app_label='dcim', model='site').pk]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) def test_assigned_object(self): @@ -922,7 +922,5 @@ class ObjectChangeTestCase(TestCase, BaseFilterSetTests): def test_changed_object_type(self): params = {'changed_object_type': 'dcim.site'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) - - def test_changed_object_type_id(self): - params = {'changed_object_type_id': ContentType.objects.get(app_label='dcim', model='site').pk} + params = {'changed_object_type_id': [ContentType.objects.get(app_label='dcim', model='site').pk]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py index e127e164a..e9bea09aa 100644 --- a/netbox/extras/urls.py +++ b/netbox/extras/urls.py @@ -107,4 +107,6 @@ urlpatterns = [ path('scripts/results//', views.ScriptResultView.as_view(), name='script_result'), re_path(r'^scripts/(?P.([^.]+)).(?P.(.+))/', views.ScriptView.as_view(), name='script'), + # Markdown + path('render/markdown/', views.RenderMarkdownView.as_view(), name="render_markdown") ] diff --git a/netbox/extras/views.py b/netbox/extras/views.py index 62cb8db36..5656050a7 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -2,7 +2,7 @@ from django.contrib import messages from django.contrib.auth.mixins import LoginRequiredMixin from django.contrib.contenttypes.models import ContentType from django.db.models import Count, Q -from django.http import Http404, HttpResponseForbidden, HttpResponse +from django.http import Http404, HttpResponseBadRequest, HttpResponseForbidden, HttpResponse from django.shortcuts import get_object_or_404, redirect, render from django.urls import reverse from django.views.generic import View @@ -14,6 +14,7 @@ from extras.dashboard.utils import get_widget_class from netbox.views import generic from utilities.forms import ConfirmationForm, get_field_value from utilities.htmx import is_htmx +from utilities.templatetags.builtins.filters import render_markdown from utilities.utils import copy_safe_request, count_related, get_viewname, normalize_querydict, shallow_compare_dict from utilities.views import ContentTypePermissionRequiredMixin, register_model_view from . import filtersets, forms, tables @@ -1076,3 +1077,18 @@ class JobResultBulkDeleteView(generic.BulkDeleteView): queryset = JobResult.objects.all() filterset = filtersets.JobResultFilterSet table = tables.JobResultTable + + +# +# Markdown +# + +class RenderMarkdownView(View): + + def post(self, request): + form = forms.RenderMarkdownForm(request.POST) + if not form.is_valid(): + HttpResponseBadRequest() + rendered = render_markdown(form.cleaned_data['text']) + + return HttpResponse(rendered) diff --git a/netbox/generate_secret_key.py b/netbox/generate_secret_key.py index c3de29cee..21efd0a6d 100755 --- a/netbox/generate_secret_key.py +++ b/netbox/generate_secret_key.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 # This script will generate a random 50-character string suitable for use as a SECRET_KEY. import secrets diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index a412c50da..10b515715 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -16,6 +16,7 @@ from virtualization.models import VirtualMachine, VMInterface from .choices import * from .models import * +from rest_framework import serializers __all__ = ( 'AggregateFilterSet', @@ -623,7 +624,33 @@ class IPAddressFilterSet(NetBoxModelFilterSet, TenancyFilterSet): return queryset.none() return queryset.filter(q) + def parse_inet_addresses(self, value): + ''' + Parse networks or IP addresses and cast to a format + acceptable by the Postgres inet type. + + Skips invalid values. + ''' + parsed = [] + for addr in value: + if netaddr.valid_ipv4(addr) or netaddr.valid_ipv6(addr): + parsed.append(addr) + continue + try: + network = netaddr.IPNetwork(addr) + parsed.append(str(network)) + except (AddrFormatError, ValueError): + continue + return parsed + def filter_address(self, queryset, name, value): + # Let's first parse the addresses passed + # as argument. If they are all invalid, + # we return an empty queryset + value = self.parse_inet_addresses(value) + if (len(value) == 0): + return queryset.none() + try: return queryset.filter(address__net_in=value) except ValidationError: diff --git a/netbox/ipam/forms/bulk_edit.py b/netbox/ipam/forms/bulk_edit.py index fe4f770a8..cd8ead81a 100644 --- a/netbox/ipam/forms/bulk_edit.py +++ b/netbox/ipam/forms/bulk_edit.py @@ -49,7 +49,6 @@ class VRFBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -70,7 +69,6 @@ class RouteTargetBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -139,7 +137,6 @@ class ASNBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -168,7 +165,6 @@ class AggregateBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -249,7 +245,6 @@ class PrefixBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -292,7 +287,6 @@ class IPRangeBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -338,7 +332,6 @@ class IPAddressBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -381,7 +374,6 @@ class FHRPGroupBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -463,7 +455,6 @@ class VLANBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -494,7 +485,6 @@ class ServiceTemplateBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) @@ -523,7 +513,6 @@ class L2VPNBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) diff --git a/netbox/ipam/forms/model_forms.py b/netbox/ipam/forms/model_forms.py index bc4c560ce..a29aabebd 100644 --- a/netbox/ipam/forms/model_forms.py +++ b/netbox/ipam/forms/model_forms.py @@ -567,6 +567,7 @@ class FHRPGroupForm(NetBoxModelForm): role=FHRP_PROTOCOL_ROLE_MAPPINGS.get(self.cleaned_data['protocol'], IPAddressRoleChoices.ROLE_VIP), assigned_object=instance ) + ipaddress.populate_custom_field_defaults() ipaddress.save() # Check that the new IPAddress conforms with any assigned object-level permissions diff --git a/netbox/ipam/graphql/types.py b/netbox/ipam/graphql/types.py index a3405126f..6e834512e 100644 --- a/netbox/ipam/graphql/types.py +++ b/netbox/ipam/graphql/types.py @@ -27,6 +27,28 @@ __all__ = ( ) +class IPAddressFamilyType(graphene.ObjectType): + + value = graphene.Int() + label = graphene.String() + + def __init__(self, value): + self.value = value + self.label = f'IPv{value}' + + +class BaseIPAddressFamilyType: + """ + Base type for models that need to expose their IPAddress family type. + """ + family = graphene.Field(IPAddressFamilyType) + + def resolve_family(self, _): + # Note that self, is an instance of models.IPAddress + # thus resolves to the address family value. + return IPAddressFamilyType(self.family) + + class ASNType(NetBoxObjectType): asn = graphene.Field(BigInt) @@ -44,7 +66,7 @@ class ASNRangeType(NetBoxObjectType): filterset_class = filtersets.ASNRangeFilterSet -class AggregateType(NetBoxObjectType): +class AggregateType(NetBoxObjectType, BaseIPAddressFamilyType): class Meta: model = models.Aggregate @@ -72,7 +94,7 @@ class FHRPGroupAssignmentType(BaseObjectType): filterset_class = filtersets.FHRPGroupAssignmentFilterSet -class IPAddressType(NetBoxObjectType): +class IPAddressType(NetBoxObjectType, BaseIPAddressFamilyType): assigned_object = graphene.Field('ipam.graphql.gfk_mixins.IPAddressAssignmentType') class Meta: @@ -95,7 +117,7 @@ class IPRangeType(NetBoxObjectType): return self.role or None -class PrefixType(NetBoxObjectType): +class PrefixType(NetBoxObjectType, BaseIPAddressFamilyType): class Meta: model = models.Prefix diff --git a/netbox/ipam/migrations/0064_clear_search_cache.py b/netbox/ipam/migrations/0064_clear_search_cache.py new file mode 100644 index 000000000..856fe99e1 --- /dev/null +++ b/netbox/ipam/migrations/0064_clear_search_cache.py @@ -0,0 +1,31 @@ +from django.db import migrations + + +def clear_cache(apps, schema_editor): + """ + Clear existing CachedValues referencing IPAddressFields or IPNetworkFields. (#11658 + introduced new cache record types for these.) + """ + ContentType = apps.get_model('contenttypes', 'ContentType') + CachedValue = apps.get_model('extras', 'CachedValue') + + for model_name in ('Aggregate', 'IPAddress', 'IPRange', 'Prefix'): + try: + content_type = ContentType.objects.get(app_label='ipam', model=model_name.lower()) + CachedValue.objects.filter(object_type=content_type).delete() + except ContentType.DoesNotExist: + pass + + +class Migration(migrations.Migration): + + dependencies = [ + ('ipam', '0063_standardize_description_comments'), + ] + + operations = [ + migrations.RunPython( + code=clear_cache, + reverse_code=migrations.RunPython.noop + ), + ] diff --git a/netbox/ipam/migrations/0064_asnrange.py b/netbox/ipam/migrations/0065_asnrange.py similarity index 96% rename from netbox/ipam/migrations/0064_asnrange.py rename to netbox/ipam/migrations/0065_asnrange.py index 6f5cfe6b8..71d056dfd 100644 --- a/netbox/ipam/migrations/0064_asnrange.py +++ b/netbox/ipam/migrations/0065_asnrange.py @@ -12,7 +12,7 @@ class Migration(migrations.Migration): dependencies = [ ('tenancy', '0009_standardize_description_comments'), ('extras', '0087_dashboard'), - ('ipam', '0063_standardize_description_comments'), + ('ipam', '0064_clear_search_cache'), ] operations = [ diff --git a/netbox/ipam/migrations/0065_iprange_mark_utilized.py b/netbox/ipam/migrations/0066_iprange_mark_utilized.py similarity index 90% rename from netbox/ipam/migrations/0065_iprange_mark_utilized.py rename to netbox/ipam/migrations/0066_iprange_mark_utilized.py index 5c2cb5858..2489289fd 100644 --- a/netbox/ipam/migrations/0065_iprange_mark_utilized.py +++ b/netbox/ipam/migrations/0066_iprange_mark_utilized.py @@ -6,7 +6,7 @@ from django.db import migrations, models class Migration(migrations.Migration): dependencies = [ - ('ipam', '0064_asnrange'), + ('ipam', '0065_asnrange'), ] operations = [ diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index fef4722c4..3d9a66567 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -10,6 +10,7 @@ from ipam.models import * from utilities.testing import ChangeLoggedFilterSetTests, create_test_device, create_test_virtualmachine from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface from tenancy.models import Tenant, TenantGroup +from rest_framework import serializers class ASNRangeTestCase(TestCase, ChangeLoggedFilterSetTests): @@ -927,6 +928,26 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'address': ['2001:db8::1/64', '2001:db8::1/65']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + # Check for valid edge cases. Note that Postgres inet type + # only accepts netmasks in the int form, so the filterset + # casts netmasks in the xxx.xxx.xxx.xxx format. + params = {'address': ['24']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 0) + params = {'address': ['10.0.0.1/255.255.255.0']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + params = {'address': ['10.0.0.1/255.255.255.0', '10.0.0.1/25']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + # Check for invalid input. + params = {'address': ['/24']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 0) + params = {'address': ['10.0.0.1/255.255.999.0']} # Invalid netmask + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 0) + + # Check for partially invalid input. + params = {'address': ['10.0.0.1', '/24', '10.0.0.10/24']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_mask_length(self): params = {'mask_length': '24'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5) diff --git a/netbox/netbox/configuration_example.py b/netbox/netbox/configuration_example.py index 7158308af..92f6133a3 100644 --- a/netbox/netbox/configuration_example.py +++ b/netbox/netbox/configuration_example.py @@ -107,6 +107,9 @@ CORS_ORIGIN_REGEX_WHITELIST = [ # r'^(https?://)?(\w+\.)?example\.com$', ] +# The name to use for the CSRF token cookie. +CSRF_COOKIE_NAME = 'csrftoken' + # Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal # sensitive information about your installation. Only enable debugging while performing testing. Never enable debugging # on a production system. @@ -127,6 +130,9 @@ EMAIL = { 'FROM_EMAIL': '', } +# Localization +ENABLE_LOCALIZATION = False + # Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and # by anonymous users. List models in the form `.`. Add '*' to this list to exempt all models. EXEMPT_VIEW_PERMISSIONS = [ @@ -168,16 +174,6 @@ LOGOUT_REDIRECT_URL = 'home' # the default value of this setting is derived from the installed location. # MEDIA_ROOT = '/opt/netbox/netbox/media' -# By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the -# class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example: -# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage' -# STORAGE_CONFIG = { -# 'AWS_ACCESS_KEY_ID': 'Key ID', -# 'AWS_SECRET_ACCESS_KEY': 'Secret', -# 'AWS_STORAGE_BUCKET_NAME': 'netbox', -# 'AWS_S3_REGION_NAME': 'eu-west-1', -# } - # Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics' METRICS_ENABLED = False @@ -217,13 +213,6 @@ RQ_DEFAULT_TIMEOUT = 300 # this setting is derived from the installed location. # SCRIPTS_ROOT = '/opt/netbox/netbox/scripts' -# The maximum size (in bytes) that an upload will be before it gets streamed to the file system. -# Useful to be able to upload files bigger than 2.5Mbyte to custom scripts for processing. -# FILE_UPLOAD_MAX_MEMORY_SIZE = 2621440 - -# The name to use for the csrf token cookie. -CSRF_COOKIE_NAME = 'csrftoken' - # The name to use for the session cookie. SESSION_COOKIE_NAME = 'sessionid' @@ -232,8 +221,15 @@ SESSION_COOKIE_NAME = 'sessionid' # database access.) Note that the user as which NetBox runs must have read and write permissions to this path. SESSION_FILE_PATH = None -# Localization -ENABLE_LOCALIZATION = False +# By default, uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the +# class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example: +# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage' +# STORAGE_CONFIG = { +# 'AWS_ACCESS_KEY_ID': 'Key ID', +# 'AWS_SECRET_ACCESS_KEY': 'Secret', +# 'AWS_STORAGE_BUCKET_NAME': 'netbox', +# 'AWS_S3_REGION_NAME': 'eu-west-1', +# } # Time zone (default: UTC) TIME_ZONE = 'UTC' diff --git a/netbox/netbox/models/features.py b/netbox/netbox/models/features.py index e70d3df7b..e82917a42 100644 --- a/netbox/netbox/models/features.py +++ b/netbox/netbox/models/features.py @@ -219,6 +219,13 @@ class CustomFieldsMixin(models.Model): return dict(groups) + def populate_custom_field_defaults(self): + """ + Apply the default value for each custom field + """ + for cf in self.custom_fields: + self.custom_field_data[cf.name] = cf.default + def clean(self): super().clean() from extras.models import CustomField diff --git a/netbox/netbox/preferences.py b/netbox/netbox/preferences.py index c88b56072..5ef216259 100644 --- a/netbox/netbox/preferences.py +++ b/netbox/netbox/preferences.py @@ -24,7 +24,7 @@ PREFERENCES = { 'pagination.per_page': UserPreference( label=_('Page length'), choices=get_page_lengths(), - description=_('The number of objects to display per page'), + description=_('The default number of objects to display per page'), coerce=lambda x: int(x) ), 'pagination.placement': UserPreference( diff --git a/netbox/netbox/search/backends.py b/netbox/netbox/search/backends.py index 10e164c09..f428842f5 100644 --- a/netbox/netbox/search/backends.py +++ b/netbox/netbox/search/backends.py @@ -54,11 +54,11 @@ class SearchBackend: """ raise NotImplementedError - def caching_handler(self, sender, instance, **kwargs): + def caching_handler(self, sender, instance, created, **kwargs): """ Receiver for the post_save signal, responsible for caching object creation/changes. """ - self.cache(instance) + self.cache(instance, remove_existing=not created) def removal_handler(self, sender, instance, **kwargs): """ @@ -80,7 +80,13 @@ class SearchBackend: def clear(self, object_types=None): """ - Delete *all* cached data. + Delete *all* cached data (optionally filtered by object type). + """ + raise NotImplementedError + + def count(self, object_types=None): + """ + Return a count of all cache entries (optionally filtered by object type). """ raise NotImplementedError @@ -218,6 +224,12 @@ class CachedValueSearchBackend(SearchBackend): # Call _raw_delete() on the queryset to avoid first loading instances into memory return qs._raw_delete(using=qs.db) + def count(self, object_types=None): + qs = CachedValue.objects.all() + if object_types: + qs = qs.filter(object_type__in=object_types) + return qs.count() + @property def size(self): return CachedValue.objects.count() diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 519f6021e..66ee787a8 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -1,5 +1,6 @@ from dataclasses import dataclass from typing import Optional +from urllib.parse import quote import django_tables2 as tables from django.conf import settings @@ -8,7 +9,6 @@ from django.db.models import DateField, DateTimeField from django.template import Context, Template from django.urls import reverse from django.utils.dateparse import parse_date -from django.utils.encoding import escape_uri_path from django.utils.html import escape from django.utils.formats import date_format from django.utils.safestring import mark_safe @@ -235,7 +235,7 @@ class ActionsColumn(tables.Column): model = table.Meta.model request = getattr(table, 'context', {}).get('request') - url_appendix = f'?return_url={escape_uri_path(request.get_full_path())}' if request else '' + url_appendix = f'?return_url={quote(request.get_full_path())}' if request else '' html = '' # Compile actions menu diff --git a/netbox/project-static/dist/netbox-dark.css b/netbox/project-static/dist/netbox-dark.css index 8b6b37a4c..74ab785a5 100644 Binary files a/netbox/project-static/dist/netbox-dark.css and b/netbox/project-static/dist/netbox-dark.css differ diff --git a/netbox/project-static/dist/netbox-light.css b/netbox/project-static/dist/netbox-light.css index 27e804c30..f12291e44 100644 Binary files a/netbox/project-static/dist/netbox-light.css and b/netbox/project-static/dist/netbox-light.css differ diff --git a/netbox/project-static/dist/netbox-print.css b/netbox/project-static/dist/netbox-print.css index f0220c050..5d7f7342b 100644 Binary files a/netbox/project-static/dist/netbox-print.css and b/netbox/project-static/dist/netbox-print.css differ diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index f34ab134c..a64ac5df7 100644 Binary files a/netbox/project-static/dist/netbox.js and b/netbox/project-static/dist/netbox.js differ diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 5286b72bb..05e29a02b 100644 Binary files a/netbox/project-static/dist/netbox.js.map and b/netbox/project-static/dist/netbox.js.map differ diff --git a/netbox/project-static/src/buttons/index.ts b/netbox/project-static/src/buttons/index.ts index e677ff599..fe2ccaaef 100644 --- a/netbox/project-static/src/buttons/index.ts +++ b/netbox/project-static/src/buttons/index.ts @@ -4,6 +4,7 @@ import { initMoveButtons } from './moveOptions'; import { initReslug } from './reslug'; import { initSelectAll } from './selectAll'; import { initSelectMultiple } from './selectMultiple'; +import { initMarkdownPreviews } from './markdownPreview'; export function initButtons(): void { for (const func of [ @@ -13,6 +14,7 @@ export function initButtons(): void { initSelectAll, initSelectMultiple, initMoveButtons, + initMarkdownPreviews, ]) { func(); } diff --git a/netbox/project-static/src/buttons/markdownPreview.ts b/netbox/project-static/src/buttons/markdownPreview.ts new file mode 100644 index 000000000..224b2beab --- /dev/null +++ b/netbox/project-static/src/buttons/markdownPreview.ts @@ -0,0 +1,45 @@ +import { isTruthy } from 'src/util'; + +/** + * interface for htmx configRequest event + */ +declare global { + interface HTMLElementEventMap { + 'htmx:configRequest': CustomEvent<{ + parameters: Record; + headers: Record; + }>; + } +} + +function initMarkdownPreview(markdownWidget: HTMLDivElement) { + const previewButton = markdownWidget.querySelector('button.preview-button') as HTMLButtonElement; + const textarea = markdownWidget.querySelector('textarea') as HTMLTextAreaElement; + const preview = markdownWidget.querySelector('div.preview') as HTMLDivElement; + + /** + * Make sure the textarea has style attribute height + * So that it can be copied over to preview div. + */ + if (!isTruthy(textarea.style.height)) { + const { height } = textarea.getBoundingClientRect(); + textarea.style.height = `${height}px`; + } + + /** + * Add the value of the textarea to the body of the htmx request + * and copy the height of text are to the preview div + */ + previewButton.addEventListener('htmx:configRequest', e => { + e.detail.parameters = { text: textarea.value || '' }; + e.detail.headers['X-CSRFToken'] = window.CSRF_TOKEN; + preview.style.minHeight = textarea.style.height; + preview.innerHTML = ''; + }); +} + +export function initMarkdownPreviews(): void { + for (const markdownWidget of document.querySelectorAll('.markdown-widget')) { + initMarkdownPreview(markdownWidget); + } +} diff --git a/netbox/project-static/src/tables/interfaceTable.ts b/netbox/project-static/src/tables/interfaceTable.ts index d2b20f322..56a0ae754 100644 --- a/netbox/project-static/src/tables/interfaceTable.ts +++ b/netbox/project-static/src/tables/interfaceTable.ts @@ -1,6 +1,5 @@ import { getElements, replaceAll, findFirstAdjacent } from '../util'; -type InterfaceState = 'enabled' | 'disabled'; type ShowHide = 'show' | 'hide'; function isShowHide(value: unknown): value is ShowHide { @@ -27,54 +26,23 @@ class ButtonState { * Underlying Button DOM Element */ public button: HTMLButtonElement; - /** - * Table rows with `data-enabled` set to `"enabled"` - */ - private enabledRows: NodeListOf; - /** - * Table rows with `data-enabled` set to `"disabled"` - */ - private disabledRows: NodeListOf; - constructor(button: HTMLButtonElement, table: HTMLTableElement) { + /** + * Table rows provided in constructor + */ + private rows: NodeListOf; + + constructor(button: HTMLButtonElement, rows: NodeListOf) { this.button = button; - this.enabledRows = table.querySelectorAll('tr[data-enabled="enabled"]'); - this.disabledRows = table.querySelectorAll('tr[data-enabled="disabled"]'); + this.rows = rows; } /** - * This button's controlled type. For example, a button with the class `toggle-disabled` has - * directive 'disabled' because it controls the visibility of rows with - * `data-enabled="disabled"`. Likewise, `toggle-enabled` controls rows with - * `data-enabled="enabled"`. + * Remove visibility of button state rows. */ - private get directive(): InterfaceState { - if (this.button.classList.contains('toggle-disabled')) { - return 'disabled'; - } else if (this.button.classList.contains('toggle-enabled')) { - return 'enabled'; - } - // If this class has been instantiated but doesn't contain these classes, it's probably because - // the classes are missing in the HTML template. - console.warn(this.button); - throw new Error('Toggle button does not contain expected class'); - } - - /** - * Toggle visibility of rows with `data-enabled="enabled"`. - */ - private toggleEnabledRows(): void { - for (const row of this.enabledRows) { - row.classList.toggle('d-none'); - } - } - - /** - * Toggle visibility of rows with `data-enabled="disabled"`. - */ - private toggleDisabledRows(): void { - for (const row of this.disabledRows) { - row.classList.toggle('d-none'); + private hideRows(): void { + for (const row of this.rows) { + row.classList.add('d-none'); } } @@ -111,17 +79,6 @@ class ButtonState { } } - /** - * Toggle visibility for the rows this element controls. - */ - private toggleRows(): void { - if (this.directive === 'enabled') { - this.toggleEnabledRows(); - } else if (this.directive === 'disabled') { - this.toggleDisabledRows(); - } - } - /** * Toggle the DOM element's `data-state` attribute. */ @@ -139,17 +96,20 @@ class ButtonState { private toggle(): void { this.toggleState(); this.toggleButton(); - this.toggleRows(); } /** - * When the button is clicked, toggle all controlled elements. + * When the button is clicked, toggle all controlled elements and hide rows based on + * buttonstate. */ public handleClick(event: Event): void { const button = event.currentTarget as HTMLButtonElement; if (button.isEqualNode(this.button)) { this.toggle(); } + if (this.buttonState === 'hide') { + this.hideRows(); + } } } @@ -174,14 +134,25 @@ class TableState { // @ts-expect-error null handling is performed in the constructor private disabledButton: ButtonState; + /** + * Instance of ButtonState for the 'show/hide virtual rows' button. + */ + // @ts-expect-error null handling is performed in the constructor + private virtualButton: ButtonState; + /** * Underlying DOM Table Caption Element. */ private caption: Nullable = null; + /** + * All table rows in table + */ + private rows: NodeListOf; + constructor(table: HTMLTableElement) { this.table = table; - + this.rows = this.table.querySelectorAll('tr'); try { const toggleEnabledButton = findFirstAdjacent( this.table, @@ -191,6 +162,10 @@ class TableState { this.table, 'button.toggle-disabled', ); + const toggleVirtualButton = findFirstAdjacent( + this.table, + 'button.toggle-virtual', + ); const caption = this.table.querySelector('caption'); this.caption = caption; @@ -203,13 +178,28 @@ class TableState { throw new TableStateError("Table is missing a 'toggle-disabled' button.", table); } + if (toggleVirtualButton === null) { + throw new TableStateError("Table is missing a 'toggle-virtual' button.", table); + } + // Attach event listeners to the buttons elements. toggleEnabledButton.addEventListener('click', event => this.handleClick(event, this)); toggleDisabledButton.addEventListener('click', event => this.handleClick(event, this)); + toggleVirtualButton.addEventListener('click', event => this.handleClick(event, this)); // Instantiate ButtonState for each button for state management. - this.enabledButton = new ButtonState(toggleEnabledButton, this.table); - this.disabledButton = new ButtonState(toggleDisabledButton, this.table); + this.enabledButton = new ButtonState( + toggleEnabledButton, + table.querySelectorAll('tr[data-enabled="enabled"]'), + ); + this.disabledButton = new ButtonState( + toggleDisabledButton, + table.querySelectorAll('tr[data-enabled="disabled"]'), + ); + this.virtualButton = new ButtonState( + toggleVirtualButton, + table.querySelectorAll('tr[data-type="virtual"]'), + ); } catch (err) { if (err instanceof TableStateError) { // This class is useless for tables that don't have toggle buttons. @@ -246,37 +236,42 @@ class TableState { private toggleCaption(): void { const showEnabled = this.enabledButton.buttonState === 'show'; const showDisabled = this.disabledButton.buttonState === 'show'; + const showVirtual = this.virtualButton.buttonState === 'show'; - if (showEnabled && !showDisabled) { + if (showEnabled && !showDisabled && !showVirtual) { this.captionText = 'Showing Enabled Interfaces'; - } else if (showEnabled && showDisabled) { + } else if (showEnabled && showDisabled && !showVirtual) { this.captionText = 'Showing Enabled & Disabled Interfaces'; - } else if (!showEnabled && showDisabled) { + } else if (!showEnabled && showDisabled && !showVirtual) { this.captionText = 'Showing Disabled Interfaces'; - } else if (!showEnabled && !showDisabled) { - this.captionText = 'Hiding Enabled & Disabled Interfaces'; + } else if (!showEnabled && !showDisabled && !showVirtual) { + this.captionText = 'Hiding Enabled, Disabled & Virtual Interfaces'; + } else if (!showEnabled && !showDisabled && showVirtual) { + this.captionText = 'Showing Virtual Interfaces'; + } else if (showEnabled && !showDisabled && showVirtual) { + this.captionText = 'Showing Enabled & Virtual Interfaces'; + } else if (showEnabled && showDisabled && showVirtual) { + this.captionText = 'Showing Enabled, Disabled & Virtual Interfaces'; } else { this.captionText = ''; } } /** - * When toggle buttons are clicked, pass the event to the relevant button's handler and update - * this instance's state. + * When toggle buttons are clicked, reapply visability all rows and + * pass the event to all button handlers * * @param event onClick event for toggle buttons. * @param instance Instance of TableState (`this` cannot be used since that's context-specific). */ public handleClick(event: Event, instance: TableState): void { - const button = event.currentTarget as HTMLButtonElement; - const enabled = button.isEqualNode(instance.enabledButton.button); - const disabled = button.isEqualNode(instance.disabledButton.button); - - if (enabled) { - instance.enabledButton.handleClick(event); - } else if (disabled) { - instance.disabledButton.handleClick(event); + for (const row of this.rows) { + row.classList.remove('d-none'); } + + instance.enabledButton.handleClick(event); + instance.disabledButton.handleClick(event); + instance.virtualButton.handleClick(event); instance.toggleCaption(); } } diff --git a/netbox/project-static/styles/netbox.scss b/netbox/project-static/styles/netbox.scss index e486bc7db..37f6c21c4 100644 --- a/netbox/project-static/styles/netbox.scss +++ b/netbox/project-static/styles/netbox.scss @@ -236,12 +236,12 @@ table { } th.asc > a::after { - content: "\f0140"; + content: '\f0140'; font-family: 'Material Design Icons'; } th.desc > a::after { - content: "\f0143"; + content: '\f0143'; font-family: 'Material Design Icons'; } @@ -416,18 +416,18 @@ nav.search { } } -// Styles for the quicksearch and its clear button; +// Styles for the quicksearch and its clear button; // Overrides input-group styles and adds transition effects .quicksearch { - input[type="search"] { - border-radius: $border-radius !important; + input[type='search'] { + border-radius: $border-radius !important; } button { margin-left: -32px !important; z-index: 100 !important; outline: none !important; - border-radius: $border-radius !important; + border-radius: $border-radius !important; transition: visibility 0s, opacity 0.2s linear; } @@ -998,9 +998,24 @@ div.card-overlay { padding: 8px; } +/* Markdown widget */ +.markdown-widget { + .nav-link { + border-bottom: 0; + + &.active { + background-color: var(--nbx-body-bg); + } + } + + .nav-tabs { + background-color: var(--nbx-pre-bg); + } +} + // Preformatted text blocks td pre { - margin-bottom: 0 + margin-bottom: 0; } pre.block { padding: $spacer; diff --git a/netbox/templates/dcim/device/inc/interface_table_controls.html b/netbox/templates/dcim/device/inc/interface_table_controls.html index 14e552439..2b082cfe6 100644 --- a/netbox/templates/dcim/device/inc/interface_table_controls.html +++ b/netbox/templates/dcim/device/inc/interface_table_controls.html @@ -7,5 +7,6 @@
    +
{% endblock extra_table_controls %} diff --git a/netbox/tenancy/forms/bulk_edit.py b/netbox/tenancy/forms/bulk_edit.py index eda256a57..ab882fe7e 100644 --- a/netbox/tenancy/forms/bulk_edit.py +++ b/netbox/tenancy/forms/bulk_edit.py @@ -106,7 +106,6 @@ class ContactBulkEditForm(NetBoxModelBulkEditForm): required=False ) comments = CommentField( - widget=forms.Textarea, label='Comments' ) diff --git a/netbox/utilities/forms/fields/fields.py b/netbox/utilities/forms/fields/fields.py index c5d2d0a1f..9948d7889 100644 --- a/netbox/utilities/forms/fields/fields.py +++ b/netbox/utilities/forms/fields/fields.py @@ -27,7 +27,7 @@ class CommentField(forms.CharField): """ A textarea with support for Markdown rendering. Exists mostly just to add a standard `help_text`. """ - widget = forms.Textarea + widget = widgets.MarkdownWidget help_text = f""" diff --git a/netbox/utilities/forms/forms.py b/netbox/utilities/forms/forms.py index a008a2c8c..bb9aaef0f 100644 --- a/netbox/utilities/forms/forms.py +++ b/netbox/utilities/forms/forms.py @@ -183,7 +183,7 @@ class ImportForm(BootstrapMixin, forms.Form): if 'data_file' in self.files: self.data_field = 'data_file' file = self.files.get('data_file') - data = file.read().decode('utf-8') + data = file.read().decode('utf-8-sig') else: data = self.cleaned_data['data'] diff --git a/netbox/utilities/forms/utils.py b/netbox/utilities/forms/utils.py index 2f08a3cce..07d69f300 100644 --- a/netbox/utilities/forms/utils.py +++ b/netbox/utilities/forms/utils.py @@ -211,6 +211,7 @@ def parse_csv(reader): # `site.slug` header, to indicate the related site is being referenced by its slug. for header in next(reader): + header = header.strip() if '.' in header: field, to_field = header.split('.', 1) headers[field] = to_field diff --git a/netbox/utilities/forms/widgets.py b/netbox/utilities/forms/widgets.py index c7e1cfb81..cb3456d2c 100644 --- a/netbox/utilities/forms/widgets.py +++ b/netbox/utilities/forms/widgets.py @@ -16,6 +16,7 @@ __all__ = ( 'ColorSelect', 'DatePicker', 'DateTimePicker', + 'MarkdownWidget', 'NumericArrayField', 'SelectDurationWidget', 'SelectSpeedWidget', @@ -87,6 +88,10 @@ class SelectDurationWidget(forms.NumberInput): template_name = 'widgets/select_duration.html' +class MarkdownWidget(forms.Textarea): + template_name = 'widgets/markdown_input.html' + + class NumericArrayField(SimpleArrayField): def clean(self, value): diff --git a/netbox/utilities/paginator.py b/netbox/utilities/paginator.py index 1f07aa42a..db6326a9c 100644 --- a/netbox/utilities/paginator.py +++ b/netbox/utilities/paginator.py @@ -76,8 +76,6 @@ def get_paginate_count(request): if 'per_page' in request.GET: try: per_page = int(request.GET.get('per_page')) - if request.user.is_authenticated: - request.user.config.set('pagination.per_page', per_page, commit=True) return _max_allowed(per_page) except ValueError: pass diff --git a/netbox/utilities/templates/form_helpers/render_field.html b/netbox/utilities/templates/form_helpers/render_field.html index ec9ceb09a..85c04df92 100644 --- a/netbox/utilities/templates/form_helpers/render_field.html +++ b/netbox/utilities/templates/form_helpers/render_field.html @@ -6,7 +6,7 @@ {# Render the field label, except for: #} {# 1. Checkboxes (label appears to the right of the field #} {# 2. Textareas with no label set (will expand across entire row) #} - {% if field|widget_type == 'checkboxinput' or field|widget_type == 'textarea' and not label %} + {% if field|widget_type == 'checkboxinput' or field|widget_type == 'textarea' or field|widget_type == 'markdownwidget' and not label %} {% else %}