NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-18 13:38:16 -06:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

14132 review changes

Browse Source
This commit is contained in:
Arthur 2023-11-15 16:14:26 -08:00
parent 58136deeaf
commit e9950459b4
7 changed files with 20 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
netbox/extras/context_managers.py
View File

@ -5,9 +5,9 @@ from .events import flush_events
@contextmanager
def event_wrapper(request):
def event_tracking(request):
"""
Enable change logging by connecting the appropriate signals to their receivers before code is run, and
Enable event tracking by connecting the appropriate signals to their receivers before code is run, and
disconnecting them afterward.
:param request: WSGIRequest object with a unique `id` set

8
netbox/extras/management/commands/runscript.py
View File

@ -11,7 +11,7 @@ from django.db import transaction
from core.choices import JobStatusChoices
from core.models import Job
from extras.api.serializers import ScriptOutputSerializer
from extras.context_managers import event_wrapper
from extras.context_managers import event_tracking
from extras.scripts import get_module_and_script
from extras.signals import clear_webhooks
from utilities.exceptions import AbortTransaction
@ -37,7 +37,7 @@ class Command(BaseCommand):
def _run_script():
"""
Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
the event_wrapper context manager (which is bypassed if commit == False).
the event_tracking context manager (which is bypassed if commit == False).
"""
try:
try:
@ -136,9 +136,9 @@ class Command(BaseCommand):
logger.info(f"Running script (commit={commit})")
script.request = request
# Execute the script. If commit is True, wrap it with the event_wrapper context manager to ensure we process
# Execute the script. If commit is True, wrap it with the event_tracking context manager to ensure we process
# change logging, webhooks, etc.
with event_wrapper(request):
with event_tracking(request):
_run_script()
else:
logger.error('Data is not valid:')

4
netbox/extras/migrations/0099_eventrule.py
View File

@ -75,8 +75,8 @@ class Migration(migrations.Migration):
to='contenttypes.contenttype',
),
),
('action_object_identifier', models.CharField(max_length=80, blank=True)),
('parameters', models.JSONField(blank=True, null=True)),
('action_parameters', models.CharField(max_length=80, blank=True)),
('action_data', models.JSONField(blank=True, null=True)),
('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
],
options={

8
netbox/extras/models/models.py
View File

@ -115,11 +115,11 @@ class EventRule(CustomFieldsMixin, ExportTemplatesMixin, TagsMixin, ChangeLogged
fk_field='action_object_id'
)
# internal (not show in UI) - used by scripts to store function name
action_object_identifier = models.CharField(
action_parameters = models.CharField(
max_length=80,
blank=True
)
parameters = models.JSONField(
action_data = models.JSONField(
verbose_name=_('parameters'),
blank=True,
null=True,
@ -137,10 +137,6 @@ class EventRule(CustomFieldsMixin, ExportTemplatesMixin, TagsMixin, ChangeLogged
def get_absolute_url(self):
return reverse('extras:eventrule', args=[self.pk])
@property
def docs_url(self):
return f'{settings.STATIC_URL}docs/models/extras/eventrule/'
def clean(self):
super().clean()

8
netbox/extras/scripts.py
View File

@ -23,7 +23,7 @@ from ipam.validators import MaxPrefixLengthValidator, MinPrefixLengthValidator,
from utilities.exceptions import AbortScript, AbortTransaction
from utilities.forms import add_blank_choice
from utilities.forms.fields import DynamicModelChoiceField, DynamicModelMultipleChoiceField
from .context_managers import event_wrapper
from .context_managers import event_tracking
from .forms import ScriptForm
__all__ = (
@ -497,7 +497,7 @@ def run_script(data, job, request=None, commit=True, **kwargs):
def _run_script():
"""
Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
the event_wrapper context manager (which is bypassed if commit == False).
the event_tracking context manager (which is bypassed if commit == False).
"""
try:
try:
@ -525,10 +525,10 @@ def run_script(data, job, request=None, commit=True, **kwargs):
logger.info(f"Script completed in {job.duration}")
# Execute the script. If commit is True, wrap it with the event_wrapper context manager to ensure we process
# Execute the script. If commit is True, wrap it with the event_tracking context manager to ensure we process
# change logging, webhooks, etc.
if commit:
with event_wrapper(request):
with event_tracking(request):
_run_script()
else:
_run_script()

6
netbox/extras/scripts_worker.py
View File

@ -24,8 +24,8 @@ def process_script(event_rule, model_name, event, data, timestamp, username, req
if not eval_conditions(event_rule, data):
return
module_id = event_rule.action_object_identifier.split(":")[0]
script_name = event_rule.action_object_identifier.split(":")[1]
module_id = event_rule.action_parameters.split(":")[0]
script_name = event_rule.action_parameters.split(":")[1]
try:
module = ScriptModule.objects.get(pk=module_id)
@ -41,5 +41,5 @@ def process_script(event_rule, model_name, event, data, timestamp, username, req
user=None,
schedule_at=None,
interval=None,
data=event_rule.parameters,
data=event_rule.action_data,
)

6
netbox/netbox/middleware.py
View File

@ -10,7 +10,7 @@ from django.db import connection, ProgrammingError
from django.db.utils import InternalError
from django.http import Http404, HttpResponseRedirect
from extras.context_managers import event_wrapper
from extras.context_managers import event_tracking
from netbox.config import clear_config, get_config
from netbox.views import handler_500
from utilities.api import is_api_request, rest_api_server_error
@ -42,8 +42,8 @@ class CoreMiddleware:
login_url = f'{settings.LOGIN_URL}?next={parse.quote(request.get_full_path_info())}'
return HttpResponseRedirect(login_url)
# Enable the event_wrapper context manager and process the request.
with event_wrapper(request):
# Enable the event_tracking context manager and process the request.
with event_tracking(request):
response = self.get_response(request)
# Attach the unique request ID as an HTTP header.