Netbox 4.1 support

Author: kkthxbye-code

netbox_script_manager/__init__.py

@@ -5,7 +5,7 @@
 __version__ = "0.4.0"
 
 
-from extras.plugins import PluginConfig
+from netbox.plugins import PluginConfig
 
 
 class NetboxScriptManagerConfig(PluginConfig):

netbox_script_manager/api/serializers.py

@@ -6,7 +6,7 @@
 from netbox.api.serializers import NetBoxModelSerializer
 from netbox.config import get_config
 from rest_framework import serializers
-from tenancy.api.nested_serializers import NestedTenantSerializer
+from tenancy.api.serializers import TenantSerializer
 from utilities.templatetags.builtins.filters import render_markdown
 
 from netbox_script_manager.choices import ScriptExecutionStatusChoices
@@ -34,7 +34,7 @@ def to_representation(self, value):
 class ScriptInstanceSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(view_name="plugins-api:netbox_script_manager-api:scriptinstance-detail")
     name = serializers.CharField(required=True)
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
+    tenant = TenantSerializer(required=False, allow_null=True, nested=True)
 
     class Meta:
         model = ScriptInstance

netbox_script_manager/api/views.py

@@ -14,7 +14,7 @@
 from rest_framework.response import Response
 from rest_framework.routers import APIRootView
 from utilities.permissions import get_permission_for_model
-from utilities.utils import copy_safe_request
+from utilities.request import copy_safe_request
 
 from .. import util
 from ..choices import ScriptExecutionStatusChoices

netbox_script_manager/forms.py

@@ -1,14 +1,15 @@
 from django import forms
-from django.contrib.auth.models import User
+from users.models import User
 from django.utils.translation import gettext as _
 from extras.choices import DurationChoices
-from extras.forms.mixins import SavedFiltersMixin
+from netbox.forms.mixins import SavedFiltersMixin
 from netbox.forms import NetBoxModelFilterSetForm, NetBoxModelForm
 from tenancy.models import Tenant
-from utilities.forms import BootstrapMixin, FilterForm
+from utilities.forms import FilterForm
 from utilities.forms.fields import DynamicModelChoiceField, DynamicModelMultipleChoiceField, TagFilterField
 from utilities.forms.widgets import APISelectMultiple, DateTimePicker, NumberWithOptions
-from utilities.utils import local_now
+from utilities.datetime import local_now
+from utilities.forms.rendering import FieldSet
 
 from .choices import ScriptExecutionStatusChoices
 from .models import ScriptExecution, ScriptInstance
@@ -57,20 +58,18 @@ class ScriptInstanceFilterForm(NetBoxModelFilterSetForm):
 
 class ScriptExecutionFilterForm(SavedFiltersMixin, FilterForm):
     fieldsets = (
-        (None, ("q", "filter_id")),
-        (
-            "Creation",
-            (
-                "created__before",
-                "created__after",
-                "scheduled__before",
-                "scheduled__after",
-                "started__before",
-                "started__after",
-                "completed__before",
-                "completed__after",
-                "user",
-            ),
+        FieldSet("q", "filter_id", name="Query Filters"),
+        FieldSet(
+            "created__before",
+            "created__after",
+            "scheduled__before",
+            "scheduled__after",
+            "started__before",
+            "started__after",
+            "completed__before",
+            "completed__after",
+            "user",
+            name="Creation and Timing",
         ),
     )
     model = ScriptExecution
@@ -94,7 +93,7 @@ class ScriptExecutionFilterForm(SavedFiltersMixin, FilterForm):
     )
 
 
-class ScriptForm(BootstrapMixin, forms.Form):
+class ScriptForm(forms.Form):
     default_renderer = forms.renderers.DjangoTemplates()
 
     _commit = forms.BooleanField(
@@ -126,6 +125,20 @@ def __init__(self, *args, scheduling_enabled=True, **kwargs):
         now = local_now().strftime("%Y-%m-%d %H:%M:%S")
         self.fields["_schedule_at"].help_text += f" (current time: <strong>{now}</strong>)"
 
+        # Stupid workaround for the insanely hacky netbox core code mentioned in #16293
+        # We can't use the default form renderer because it messes up checkboxes,
+        # so we have to manually inject the form-control class into all input fields.
+        for field in self.fields.values():
+            widget_type = type(field.widget)
+            if issubclass(widget_type, forms.widgets.Input) or issubclass(widget_type, forms.widgets.Textarea):
+                if hasattr(field.widget, "input_type") and field.widget.input_type == "checkbox":
+                    continue
+
+                if "class" in field.widget.attrs:
+                    field.widget.attrs["class"] += " form-control"
+                else:
+                    field.widget.attrs["class"] = "form-control"
+
         # Remove scheduling fields if scheduling is disabled
         if not scheduling_enabled:
             self.fields.pop("_schedule_at")

netbox_script_manager/models.py

@@ -5,15 +5,15 @@
 
 import django_rq
 from django.conf import settings
-from django.contrib.auth.models import User
+from users.models import User
 from django.contrib.postgres.fields import ArrayField
 from django.core import serializers
 from django.core.validators import MinValueValidator
 from django.db import models
 from django.urls import reverse
 from django.utils import timezone
 from netbox.models import PrimaryModel
-from netbox.models.features import ChangeLoggingMixin, ExportTemplatesMixin, WebhooksMixin
+from netbox.models.features import ChangeLoggingMixin, ExportTemplatesMixin, EventRulesMixin
 from utilities.querysets import RestrictedQuerySet
 
 from .choices import LogLevelChoices, ScriptExecutionStatusChoices
@@ -45,9 +45,6 @@ class Meta:
     def __str__(self):
         return str(self.pk)
 
-    def get_absolute_url(self):
-        return reverse("plugins:netbox_script_manager:script_log_line", args=[self.pk])
-
     def get_level_color(self):
         return LogLevelChoices.colors.get(self.level)
 
@@ -74,7 +71,7 @@ def get_absolute_url(self):
         return reverse("plugins:netbox_script_manager:scriptartifact_download", args=[self.pk])
 
 
-class ScriptExecution(ExportTemplatesMixin, WebhooksMixin, ChangeLoggingMixin, models.Model):
+class ScriptExecution(ExportTemplatesMixin, EventRulesMixin, ChangeLoggingMixin, models.Model):
     script_instance = models.ForeignKey(
         to="ScriptInstance",
         on_delete=models.CASCADE,
@@ -153,7 +150,7 @@ def delete(self, *args, **kwargs):
         if task:
             task.cancel()
 
-    def serialize_object(obj, resolve_tags=True, extra=None):
+    def serialize_object(obj, resolve_tags=True, extra=None, exclude=None):
         """
         While the netbox serialize_object claims to support excluding fields, it doesn't in reality.
         """

netbox_script_manager/navigation.py

@@ -1,5 +1,4 @@
-from extras.plugins import PluginMenuButton, PluginMenuItem
-from utilities.choices import ButtonColorChoices
+from netbox.plugins import PluginMenuButton, PluginMenuItem
 
 menu_items = (
     PluginMenuItem(
@@ -11,7 +10,6 @@
                 link="plugins:netbox_script_manager:scriptinstance_load",
                 title="Load Scripts",
                 icon_class="mdi mdi-refresh",
-                color=ButtonColorChoices.CYAN,
                 permissions=["netbox_script_manager.add_scriptinstance"],
             ),
         ),

netbox_script_manager/project-static/src/App.svelte

@@ -16,11 +16,11 @@
 
     // Mapping of log level to bootstrap color
     let levelColors = {
-        debug: "bg-gray",
-        info: "bg-cyan",
-        success: "bg-green",
-        warning: "bg-yellow",
-        failure: "bg-red",
+        debug: "text-bg-gray",
+        info: "text.bg-cyan",
+        success: "text-bg-green",
+        warning: "text-bg-yellow",
+        failure: "text-bg-red",
     };
 
     // Column definitions
@@ -44,7 +44,7 @@
             renderValue: (v) => {
                 let bgColor = levelColors[v.level.toLowerCase()];
                 return `<span class="badge ${bgColor}">${capitalize(
-                    v.level
+                    v.level,
                 )}</span>`;
             },
             parseHTML: true,
@@ -148,4 +148,5 @@
     {rows}
     bind:filterSelections={selection}
     classNameTable={["table table-hover"]}
+    classNameInput={["ts-control"]}
 />

netbox_script_manager/scripts.py

@@ -10,9 +10,9 @@
 from django.db import transaction
 from django.forms.fields import BooleanField
 from django.utils.functional import classproperty
-from extras.context_managers import change_logging
+from netbox.context_managers import event_tracking
 from extras.scripts import ScriptVariable
-from extras.signals import clear_webhooks
+from core.signals import clear_events
 from utilities.exceptions import AbortScript, AbortTransaction
 
 from .choices import LogLevelChoices, ScriptExecutionStatusChoices
@@ -263,7 +263,7 @@ def _run_script():
                         raise AbortTransaction()
             except AbortTransaction:
                 script.log_info("Database changes have been reverted automatically.")
-                clear_webhooks.send(request)
+                clear_events.send(request)
 
             script_execution.data["output"] = str(output)
             script_execution.terminate()
@@ -280,14 +280,14 @@ def _run_script():
             script_execution.data["output"] = str(output)
 
             script_execution.terminate(status=ScriptExecutionStatusChoices.STATUS_ERRORED)
-            clear_webhooks.send(request)
+            clear_events.send(request)
 
         logger.info(f"Script completed in {script_execution.duration}")
 
     # Execute the script. If commit is True, wrap it with the change_logging context manager to ensure we process
     # change logging, webhooks, etc.
     if commit:
-        with change_logging(request):
+        with event_tracking(request):
             _run_script()
     else:
         _run_script()
@@ -307,7 +307,7 @@ def _run_script():
             "output": None,
         }
 
-        with change_logging(request):
+        with event_tracking(request):
             next_execution = ScriptExecution(
                 script_instance=script_execution.script_instance,
                 task_id=uuid.uuid4(),

netbox_script_manager/static/netbox_script_manager/main.js

@@ -17,7 +17,7 @@ class ScriptInstanceTable(NetBoxTable):
     last_execution = tables.TemplateColumn(
         template_code="""
             {% if value %}
-                {{ value.created }}
+                {{ value.created|isodatetime }}
             {% else %}
                 <span class="text-muted">Never</span>
             {% endif %}